PHP 编码规范 4.5 文档注释
2013-04-14 09:19
393 查看
4.5 文档注释
文档注释描述php的类、构造器,方法,以及字段(field)。每个文档注释都会被置于注释定界符/**...*/之中,一个注释对应一个类或成员。该注释应位于声明之前:
/**
* 说明这个类的一些 ...
*/
class Example { ...
注意顶层(top-level)的类是不缩进的,而其成员是缩进的。描述类的文档注释的第一行(/**)不需缩进;随后的文档注释每行都缩进1格(使星号纵向对齐)。成员,包括构造函数在内,其文档注释的第一行缩进4格,随后每行都缩进5格。
若你想给出有关类、变量或方法的信息,而这些信息又不适合写在文档中,则可使用实现块注释(见5.1.1)或紧跟在声明后面的单行注释(见5.1.2)。例如,有关一个类实现的细节,应放入紧跟在类声明后面的实现块注释中,而不是放在文档注释中。
文档注释不能放在一个方法或构造器的定义块中,因为程序会将位于文档注释之后的第一个声明与其相关联。
文档注释描述php的类、构造器,方法,以及字段(field)。每个文档注释都会被置于注释定界符/**...*/之中,一个注释对应一个类或成员。该注释应位于声明之前:
/**
* 说明这个类的一些 ...
*/
class Example { ...
注意顶层(top-level)的类是不缩进的,而其成员是缩进的。描述类的文档注释的第一行(/**)不需缩进;随后的文档注释每行都缩进1格(使星号纵向对齐)。成员,包括构造函数在内,其文档注释的第一行缩进4格,随后每行都缩进5格。
若你想给出有关类、变量或方法的信息,而这些信息又不适合写在文档中,则可使用实现块注释(见5.1.1)或紧跟在声明后面的单行注释(见5.1.2)。例如,有关一个类实现的细节,应放入紧跟在类声明后面的实现块注释中,而不是放在文档注释中。
文档注释不能放在一个方法或构造器的定义块中,因为程序会将位于文档注释之后的第一个声明与其相关联。
相关文章推荐
- PHP 编码规范 4.3 尾端注释
- PHP编码规范(PHPCMS开发文档)
- 《从零开始学Swift》学习笔记(Day 57)——Swift编码规范之注释规范:文件注释、文档注释、代码注释、使用地标注释
- PHP编码规范(PHPCMS开发文档)
- PHP编码规范之注释和文件结构说明
- 【小结】PHP之文档注释规范PHPDoc
- 理解学习PHP编码规范之注释和文件结构
- 《从零开始学Swift》学习笔记(Day 57)——Swift编码规范之注释规范:文件注释、文档注释、代码注释、使用地标注释
- PHP 编码规范 3.1 开头注释
- PHP编码规范之注释和文件结构说明
- java基础第一讲——JDK、注释、帮助文档、编码规范
- PHP编码规范(PHPCMS开发文档,PHP学习者从此开始)
- php代码注释规范,php文档,phpdoc,phpdocuments
- PHP 高级编程(1/5) - 编码规范及文档编写
- PHP 编码规范 4.1 块注释
- 如何写PHP规范注释
- PHP 编码规范手册
- PHP注释语法规范与命名规范详解篇
- php 注释规范
- 【推荐】PHP编码规范