适用于MVC框架的phpDocumentor标签？

Question

我刚开始使用PhpDocumentor...

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

Modules -module_test -controller -indexController -views -indexView -models -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标记：

/**
* 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标记：

/**
* 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
*/

函数

每个函数，包括对象方法，都必须有一个文档块，该文档块至少包含：

A description of the function

All of the arguments

All of the possible return values

Answer 2

以下代码是由VIM的PHPDocumenter插件创建的。我已经使用它很长一段时间了，我认为它已经足够了。仅供参考。

/**
 * 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}
 */