PHP中的软件包的文档？

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了PHP中的软件包的文档？，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含2520字，纯文字阅读大概需要4分钟。

内容图文

因此,在PayPal文件夹中,我拥有使用其API的多个类.

我想制作一个文档,说明如何按顺序使用所有类.所以这是我的问题：

>如何为他们创建一个包裹？导致以上每个类,我使用了phpdoc标签@package PayPal.是一个在PHP包只是一个文件夹？
>我将包装文件放在哪里？有最佳做法吗？名为…的文件夹中的文件？
>如何放置类或包特定的示例,例如步骤1 bla bla,步骤2 bla bla？
谢谢！

解决方法:

您可以在单独的文件中为多个类使用相同的程序包注释. PHP Documentor将收集它们,并在创建API Docs时使用相同的程序包注释对文件进行分组.

例如http://framework.zend.com/svn/framework/standard/trunk/library/Zend/Validate.php

/**
 * @category   Zend
 * @package    Zend_Validate
 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Validate implements Zend_Validate_Interface

和http://framework.zend.com/svn/framework/standard/trunk/library/Zend/Validate/Alnum.php

/**
 * @category   Zend
 * @package    Zend_Validate
 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Validate_Alnum extends Zend_Validate_Abstract

两者都是单独的文件,但属于Zend_Validate包.因此,在http://framework.zend.com/apidoc/core/上,您可以找到它们分组在同一个程序包中.

您还可以具有子程序包,以将其他类分组在正常程序包下.例如http://framework.zend.com/svn/framework/standard/trunk/library/Zend/Validate/Sitemap/Lastmod.php

/**
 * Validates whether a given value is valid as a sitemap <lastmod> value
 *
 * @link       http://www.sitemaps.org/protocol.php Sitemaps XML format
 *
 * @category   Zend
 * @package    Zend_Validate
 * @subpackage Sitemap
 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Validate_Sitemap_Lastmod extends Zend_Validate_Abstract

请参阅上述链接的API文档,以查看生成后的显示方式.

您没有文档包注释.注释仅用于对概念上属于的类或文件进行逻辑分组.如果要获取软件包说明,请将其写入该软件包中最合适的文件中,或者创建一个单独的文件,并为其赋予与该软件包中其他文件/类相同的注释.

对于使用包的示例,您可以使用示例注释链接到包含示例的文件,或者简单地将它们与DocBlocks中的代码标记一起内联编写.如果您使用单独的文件来记录您的包裹,则可以在其中插入它们.

/**
 * MyLib
 *
 * Files under the MyLib package do foo and bar. They are baz.
 * 
 * Usage Examples of MyLib classes
 * <code>
 * $foo = new Foo;
 * $foo->doSomething()
 * </code>
 *
 * @package MyLib
 *
 * @example /some/path/to/an/example/file 
 */

内容总结

以上是互联网集市为您收集整理的PHP中的软件包的文档？全部内容，希望文章能够帮你解决PHP中的软件包的文档？所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端