跳转到主内容
新派编程网 - 新潮编程理念,全新技术课堂!

Delphi中资源文件 PHP文件注释标记及规范小结

PHP 注释标记@access使用范围:class,function,var,define,module该标记用于指明关键字的存取权限:private、public或proteced@author指明作者@copyright使用范围:class,function,var,define,module,use指明版权信息@deprecated使用范围:class,function,var,define,module,constent,global,include指明不用或者废弃的关键字@example该标记用于解析一段文件内容,并将他们高亮显示。Phpdoc会试图从该标记给的文件路径中读取文件内容@const使用范围:define用来指明php中define的常量@final使用范围:class,function,var指明关键字是一个最终的类、方法、属性,禁止派生、修改。

@filesource和example类似,只不过该标记将直接读取当前解析的php文件的内容并显示。

@global指明在此函数中引用的全局变量@ingore用于在文档中忽略指定的关键字@license相当于html标签中的,首先是URL,接着是要显示的内容例如百度可以写作 @license http://www.baidu.com 百度@link类似于license但还可以通过link指到文档中的任何一个关键字@name为关键字指定一个别名。

@package使用范围:页面级别的-> define,function,include类级别的->class,var,methods用于逻辑上将一个或几个关键字分到一组。

@abstrcut说明当前类是一个抽象类@param指明一个函数的参数@return指明一个方法或函数的返回指@static指明关建字是静态的。

@var指明变量类型@version指明版本信息@todo指明应该改进或没有实现的地方@throws指明此函数可能抛出的错误异常,极其发生的情况普通的文档标记标记必须在每行的开头以@标记,除此之外,还有一种标记叫做inline tag,用{@}表示,具体包括以下几种:{@link}用法同@link{@source}显示一段函数或方法的内容注释规范a.注释必须是/*** 注释内容*/的形式b.对于引用了全局变量的函数,必须使用glboal标记。

c.对于变量,必须用var标记其类型(int,string,bool…)

d.函数必须通过param和return标记指明其参数和返回值e.对于出现两次或两次以上的关键字,要通过ingore忽略掉多余的,只保留一个即可f.调用了其他函数或类的地方,要使用link或其他标记链接到相应的部分,便于文档的阅读。

g.必要的地方使用非文档性注释,提高代码易读性。

h.描述性内容尽量简明扼要,尽可能使用短语而非句子。

i.全局变量,静态变量和常量必须用相应标记说明以上就介绍了Delphi中资源文件 PHP文件注释标记及规范小结,包括了Delphi中资源文件方面的内容,希望对PHP教程有兴趣的朋友有所帮助。

相关文章