PHPDocument 代码注释的规范写法总结
-
原创
-
2016-07-25 08:57:10
734浏览
/** - * 文件名(sample2.php)
- * by bbs.it-home.org
- * 功能描述(略)
- * @package sample2
- */
/** - * 包含文件
- */
- include_once 'sample3.php';
/** - * 声明全局变量
- * @global integer $GLOBALS['_myvar']
- * @name $_myvar
- */
- $GLOBALS['_myvar'] = 6;
/** - * 声明全局常量
- */
- define('NUM', 6);
/** - * 类名
- *
- * 类功能描述
- *
- * @package sample2
- * @subpackage classes(如果是父类 就添加)
- */
- class myclass {
/** - * 声明普通变量
- *
- * @accessprivate
- * @var integer|string
- */
- var $firstvar = 6;
/** - * 创建构造函数 {@link $firstvar}
- */
- function myclass() {
- $this->firstvar = 7;
- }
/** - * 定义函数
- *
- * 函数功能描述
- *
- * @global string $_myvar
- * @staticvar integer $staticvar
- * @param string $param1
- * @param string $param2
- * @return integer|string
- */
- function firstFunc($param1, $param2 = 'optional') {
- static $staticvar = 7;
- global $_myvar;
- return $staticvar;
- }
- }
- ?>
复制代码 |
声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn核实处理。