知识大全关于PHPDocument 代码注释规范的总结

Posted 2022-07-21 知

篇首语：历览千载书，时时见遗烈。本文由小常识网(cha138.com)小编为大家整理，主要介绍了知识大全关于PHPDocument 代码注释规范的总结相关的知识，希望对你有一定的参考价值。

关于PHPDocument 代码注释规范的总结 以下文字资料是由(全榜网网www.cha138.com)小编为大家搜集整理后发布的内容，让我们赶快一起来看一下吧！

　　 安装phpDocumentor（不推荐命令行安装） 在下载最新版本的PhpDoc 放在web服务器目录下使得通过浏览器可以访问到点击files按钮选择要处理的php文件或文件夹还可以通过该指定该界面下的Files to ignore来忽略对某些文件的处理然后点击output按钮来选择生成文档的存放路径和格式最后点击create phpdocumentor就会自动开始生成文档了

　　 ．如何写PHP规范注释 所有的文档标记都是在每一行的 * 后面以@开头如果在一段话的中间出来@的标记这个标记将会被当做普通内容而被忽略掉 @access 该标记用于指明关键字的存取权限 private public或proteced 使用范围 class function var define module @author 指明作者 @copyright 指明版权信息 @const 使用范围 define 用来指明php中define的常量 @final 使用范围 class function var 指明关键字是一个最终的类方法属性禁止派生修改 @global 指明在此函数中引用的全局变量 @name 为关键字指定一个别名 @package 用于逻辑上将一个或几个关键字分到一组 @abstrcut 说明当前类是一个抽象类 @param 指明一个函数的参数 @return 指明一个方法或函数的返回值 @static 指明关建字是静态的 @var 指明变量类型 @version 指明版本信息 @todo 指明应该改进或没有实现的地方 @link 可以通过link指到文档中的任何一个关键字 @ingore 用于在文档中忽略指定的关键字

　　一些注释规范 a 注释必须是 /** * XXXXXXX */ 的形式 b 对于引用了全局变量的函数必须使用glboal标记 c 对于变量必须用var标记其类型（int string bool ） d 函数必须通过param和return标记指明其参数和返回值 e 对于出现两次或两次以上的关键字要通过ingore忽略掉多余的只保留一个即可 f 调用了其他函数或类的地方要使用link或其他标记链接到相应的部分便于文档的阅读 g 必要的地方使用非文档性注释（PHPDOC无法识别的关键字前的注释）提高代码易读性 h 描述性内容尽量简明扼要尽可能使用短语而非句子 i 全局变量静态变量和常量必须用相应标记说明

　　能够被phpdoc识别的关键字 Include Require include_once require_once define function global class

cha138/Article/program/PHP/201311/21335

知识大全 关于PHPDocument 代码注释规范的总结

知识大全关于PHPDocument 代码注释规范的总结