自动生成PHP文档工具PHPdocument的Api文档之中标签注释风格集锦。
官网Api链接:
https://docs.phpdoc.org/references/phpdoc/index.html
范例:从上面的看就是非常凌乱的注释风格,非常随性,有点low,现在规范一下,在 http://php.net/manual/zh/ 并未找到注释风格的章节说明,那么就以开源工具phpdoc的注释风格为准好了。
由于phpdoc文档说明很多而且很多并没用到的,网站打开又比较慢,那么在这里就整理一个较常用的注释模板
不过以前一直以@method(其实用来说明函数内部调用的魔术方法)来声明方法名称,想想,也没什么问题哈哈,开心就好,大致规范一下就好,免得越跑越远了,嘿嘿
常用的不过 方法名称、参数、作者、返回值、示例:
???/** ???????* 测试方法 ???????* @author My Name <my.name@qq.com> ???????* @link ?/index/test ???????* @param ?$_POST[‘PRONUM‘]; 商品数量 int ???????* @param [ Type ] [name] [<description>] ???????* @param [ int ] [$_POST[‘PROID‘]] [<商品ID>] ???????* @copyright 2017-12-16 php group ???????* @return [array] [成功的时候返回{‘status‘:true,‘data‘:‘success‘,‘code‘:0}] ???????* @example 示例说明,文字数组等等diy ???????* @version 1.0.1 ????*/ ???function test() ???{ ???????echo ‘i am test‘; ???}
参考博客:
https://www.cnblogs.com/hellohell/p/5733712.html
PHPDOC文档工具注释风格整理
原文地址:http://www.cnblogs.com/xuweiqiang/p/8046468.html