适用于MVC框架的phpDocumentor标记?
我刚刚开始使用PhpDocumentor 如果我有一个名为foo的项目,并且正在模块化体系结构中使用zend framework: 模块 -模块测试 -控制器 -索引控制器 -观点 -索引视图 -模型 -指数模型 什么phpdoc标签最好使用 现在我正在考虑(例如indexController.php) 这是否足够?适用于MVC框架的phpDocumentor标记?,php,zend-framework,phpdoc,Php,Zend Framework,Phpdoc,我刚刚开始使用PhpDocumentor 如果我有一个名为foo的项目,并且正在模块化体系结构中使用zend framework: 模块 -模块测试 -控制器 -索引控制器 -观点 -索引视图 -模型 -指数模型 什么phpdoc标签最好使用 现在我正在考虑(例如indexController.php) 这是否足够? 非常感谢您的回复:)以下内容是由用于VIM的phpDocument插件创建的。我已经用了很长时间了,我认为它已经足够了。仅供参考 /** * Class name * *
非常感谢您的回复:)以下内容是由用于VIM的phpDocument插件创建的。我已经用了很长时间了,我认为它已经足够了。仅供参考
/**
* 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}
*/
/**
*类名
*
*@使用父类
*@package
*@version$id$
*@copyright 1997-2005 PHP组
*@author我的名字
*@license PHP版本3.0{@linkhttp://www.php.net/license/3_0.txt}
*/
Zend Framework有一些标准,它定义为内联文档所需的标准,因此您可以将这些标准用作指南。并非所有Zend Framework类都使用所有标记,因此使用时您可以根据自己的判断省略一些标记
请参见ZF文档页面上的
文件
包含PHP代码的每个文件的顶部都必须有一个docblock,该文件至少包含以下phpDocumentor标记:
课程
每个类都必须有一个docblock,其中至少包含以下phpDocumentor标记:
功能
每个函数(包括对象方法)必须有一个docblock,该docblock至少包含:
/**
* 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}
*/
/**
* 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
*/
/**
* 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