因此,在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
*/
标签：phpdoc,php 来源： https://codeday.me/bug/20191106/2000517.html
本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享； 2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关； 3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关； 4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除； 5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。