Question

我刚开始使用PhpDocumentor ......

如果我有一个名为foo的项目，并且在模块化架构中使用了zend框架：

模块 -module_test -controller -indexController -views -indexView -楷模 -index_model

什么phpdoc标签可以使用？

现在我正在考虑（例如indexController.php）

/**
 * @author some author
 * @category module_test
 * @package controllers
 * @copyright http://rainbowriders.dk Rainbow Riders ApS
 * @version 1.0
 */

那会足够吗？非常感谢任何回复：）

Answer 1

Zend Framework有一些标准，它定义为内联文档所需的标准，因此您可以将它们用作指南。并非所有Zend Framework类都使用所有标记，因此您可以根据自己的判断省略一些标记。

请参阅ZF文档页面上的Coding Standards - Inline Documentation。

<强>文件

每个包含PHP代码的文件必须至少包含这些phpDocumentor标记的文件顶部有一个docblock：

/**
* Short description for file
*
* Long description for file (if any)...
*
* LICENSE: Some license information
*
* @category   Zend
* @package    Zend_Magic
* @subpackage Wand
* @copyright  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
* @license    http://framework.zend.com/license   BSD License
* @version    $Id:$
* @link       http://framework.zend.com/package/PackageName
* @since      File available since Release 1.5.0
*/

<强>类

每个类必须至少包含这些phpDocumentor标记的docblock：

/**
* Short description for class
*
* Long description for class (if any)...
*
* @category   Zend
* @package    Zend_Magic
* @subpackage Wand
* @copyright  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
* @license    http://framework.zend.com/license   BSD License
* @version    Release: @package_version@
* @link       http://framework.zend.com/package/PackageName
* @since      Class available since Release 1.5.0
* @deprecated Class deprecated in Release 2.0.0
*/

<强>功能

每个函数（包括对象方法）都必须包含至少包含的docblock：

A description of the function

All of the arguments

All of the possible return values

Answer 2

以下是由VIM的PHPDocumenter插件创建的。我已经使用了很长时间，我认为这已经足够了。只是fyi。

/**
 * Class name 
 * 
 * @uses parent class
 * @package 
 * @version $id$
 * @copyright 1997-2005 The PHP Group
 * @author my name <my@php.net> 
 * @license PHP Version 3.0 {@link http://www.php.net/license/3_0.txt}
 */

适用于MVC框架的phpDocumentor标签？

2 个答案: