电商网站建设 网站定制开发,免费网站模板的制作方法,江阴响应式网站建设,儿童摄影网页制作代码htmlPHP文件注释标记及规范小结发布时间#xff1a;2016-06-17 来源#xff1a; 点击:次PHP 注释标记access使用范围#xff1a;class,function,var,define,module该标记用于指明关键字的存取权限#xff1a;private、public或protecedauthor指明作者copyright使用范围#xf…PHP文件注释标记及规范小结发布时间2016-06-17 来源 点击:次PHP 注释标记access使用范围class,function,var,define,module该标记用于指明关键字的存取权限private、public或protecedauthor指明作者copyright使用范围classfunctionvardefinemoduleuse指明版权信息deprecated使用范围classfunctionvardefinemoduleconstentglobalinclude指明不用或者废弃的关键字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使用范围页面级别的- definefunctioninclude类级别的-classvarmethods用于逻辑上将一个或几个关键字分到一组。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.全局变量静态变量和常量必须用相应标记说明这就是微学网-程序员之家为你提供的PHP文件注释标记及规范小结希望对你有所帮助.本文来自网络转载请注明出处http://www.weixuecn.cn/article/610.html
