关于PHPDocument 代码注释规范的总结

  次阅读 作者:智能小宝 来源:互联网 2016-03-02 15:33 我要评论(0)

1. 安装phpDocumentor(不推荐命令行安装)在http://manual.phpdoc.org/下载最新版本的PhpDoc

放在web服务器目录下使得通过浏览器可以访问到

点击files按钮,选择要处理的php文件或文件夹

还可以通过该指定该界面下的Files to ignore来忽略对某些文件的处理。

然后点击output按钮来选择生成文档的存放路径和格式.

最后点击create,phpdocumentor就会自动开始生成文档了。

2.如何写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

3. 规范注释的php代码 :<?php

/**

* 文件名(sample2.php)

*

* 功能描述(略)

*

* @author steve <http://www.jb51.net>

* @version 1.0

* @package sample2

本站文章信息来源于网络以及网友投稿,本站只负责对文章进行整理、排版、编辑,是出于传递更多信息之目的,并不意味着赞同其观点或证实其内容的真实性。如果您有什么意见或建议,请联系QQ28-1688-302!

人工智能实验室
相关文章相关文章
  • 韩春雨称已能重复实验结果 近期将有消息公布

    韩春雨称已能重复实验结果 近期将有消息公布

  • 英国研发“杀生”机器人 通过生命体获取能量

    英国研发“杀生”机器人 通过生命体获取能量

  • 未来两年人工智能要怎么走?看这篇就够了

    未来两年人工智能要怎么走?看这篇就够了

  • 无人驾驶汽车如何改变城市生活?听听他们怎么说

    无人驾驶汽车如何改变城市生活?听听他们怎么说

网友点评网友点评
阅读推荐阅读推荐

据国外媒体报道,在过去两年内,聊天机器人(chatbot)、人工智能以及机器学习的研发和采用取得了巨大进展。许多初创公司正利用人工智能和...

霍金 视觉中国 图 英国著名物理学家霍金(Stephen Hawking)再次就人工智能(AI)发声,他认为:对于人类来说,强大AI的出现可能是最美妙的...

文|郑娟娟 今年,人工智能(AI) 60岁了。在AI60岁的时候,笔者想要介绍一下AI100,一个刚刚2岁的研究项目,但它的预设寿命是100年,甚至更长...

AlphaGo与李世石的人机大战,为大众迅速普及了人工智能的概念。 但对谷歌而言,除了下围棋,现在的人工智能进展到哪一步了?未来,人工智能...