快精灵印艺坊 您身边的文印专家
广州名片 深圳名片 会员卡 贵宾卡 印刷 设计教程
产品展示 在线订购 会员中心 产品模板 设计指南 在线编辑
 首页 名片设计   CorelDRAW   Illustrator   AuotoCAD   Painter   其他软件   Photoshop   Fireworks   Flash  

 » 彩色名片
 » PVC卡
 » 彩色磁性卡
 » 彩页/画册
 » 个性印务
 » 彩色不干胶
 » 明信片
   » 明信片
   » 彩色书签
   » 门挂
 » 其他产品与服务
   » 创业锦囊
   » 办公用品
     » 信封、信纸
     » 便签纸、斜面纸砖
     » 无碳复印纸
   » 海报
   » 大篇幅印刷
     » KT板
     » 海报
     » 横幅

PHP 编码规范(8)

4.5 文档注释

文档注释描述php的类、构造器,方式,以及字段(field)。每个文档注释都会被置于注释定界符/**...*/之中,一个注释对应一个类或成员。该注释应位于声明之前:


/**
 * 说明这个类的一些 ...
*/
class Example { ...

注重顶层(top-level)的类是不缩进的,而其成员是缩进的。描述类的文档注释的第一行(/**)不需缩进;随后的文档注释每行都缩进1格(使星号纵向对齐)。成员,包括构造函数在内,其文档注释的第一行缩进4格,随后每行都缩进5格。

若你想给出有关类、变量或方式的信息,而这些信息又不适合写在文档中,则可使用实现块注释(见5.1.1)或紧跟在声明后面的单行注释(见5.1.2)。例如,有关一个类实现的细节,应放入紧跟在类声明后面的实现块注释中,而不是放在文档注释中。

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


返回类别: 教程
上一教程: 第十四节--命名空间 -- Classes and Objects in PHP5 [14]
下一教程: require()和include()的区别-摘自网猴

您可以阅读与"PHP 编码规范(8)"相关的教程:
· PHP 编码规范(10)
· PHP 编码规范(2)
· PHP 编码规范(13)
· PHP 编码规范(7)
· PHP 编码规范(16)
    微笑服务 优质保证 索取样品