首页 > 语言 > 关键词  > php最新资讯  > 正文

PHP 编码规范-注释

2009-02-19 13:48 · 稿源:PHPChina

《PHP 编码规范-注释》文章已经归档,站长之家不再展示相关内容,下文是站长之家的自动化写作机器人,通过算法提取的文章重点内容。这只AI还很年轻,欢迎联系我们帮它成长:

它们也可以被用于其他地方,比如方法内部...

块注释之首应该有一个空行,用于把块注释和代码分割开来,比如:...

注意:如果你不使用indent,就不必在代码中使用/*-,或为他人可能对你的代码运行indent作让步...

如果一个注释不能在一行内写完,就该采用块注释...

极短的注释可以与它们所要描述的代码位于同一行,但是应该有足够的空白来分开代码和注释...

每个文档注释都会被置于注释定界符/**...

*/之中,一个注释对应一个类或成员...

描述类的文档注释的第一行不需缩进;随后的文档注释每行都缩进1格...

若你想给出有关类、变量或方法的信息,而这些信息又不适合写在文档中,则可使用实现块注释或紧跟在声明后面的单行注释...

文档注释不能放在一个方法或构造器的定义块中,因为程序会将位于文档注释之后的第一个声明与其相关联...

......

本文由站长之家用户“PHPChina”投稿,本平台仅提供信息索引服务。由于内容发布时间超过平台更新维护时间,为了保证文章信息的及时性,内容观点的准确性,平台将不提供完整的内容展现,本页面内容仅为平台搜索索引使用。需阅读完整内容的用户,请联系作者获取原文。

举报

  • 相关推荐
  • 大家在看

今日大家都在搜的词: