2-1PHP代码基本语法 程序注释是书写规范程序时很重要的一个环节。注释主要针对代码的解 释和说明,用来解释脚本的用途、版权说明、版本号、生成日期、作者 内容等,有助于对程序的阅读理解。合理使用注释有以下几项原则: (1)注释语言必须准确、易懂、简洁。 (2)注释在编译代码时会被忽略,不会被编译到最后的可执行文件中, 所以注释不会增加可执行文件的大小。 (3)注释可以书写在代码中的任意位置,但是一般写在代码的开头或者 结束位置。 说明: 避免在一行代码或表达式的中间插入注释,否则容易使代码可理解性变 差 (4)修改程序代码时,一定要同时修改相关的注释,保持代码和注释的 同步。 (5)在实际的代码规范中,要求注释占程序代码的比例达到20%左右,即 100行程序中包含20行左右的注释 (6)在程序块的结束行右方加注释标记,以表明某程序块的结束。 (⑦)避免在注释中使用缩写,特别是非常用缩写 8)注释与所描述内容进行同样的缩排,可使程序排版整齐,并方便注 释的阅读与理解 PHP编程基础与实例教程PHP编程基础与实例教程 2-1 PHP代码基本语法 程序注释是书写规范程序时很重要的一个环节。注释主要针对代码的解 释和说明，用来解释脚本的用途、版权说明、版本号、生成日期、作者、 内容等，有助于对程序的阅读理解。合理使用注释有以下几项原则： （1）注释语言必须准确、易懂、简洁。 （2）注释在编译代码时会被忽略，不会被编译到最后的可执行文件中， 所以注释不会增加可执行文件的大小。 （3）注释可以书写在代码中的任意位置，但是一般写在代码的开头或者 结束位置。 说明： 避免在一行代码或表达式的中间插入注释，否则容易使代码可理解性变 差。 （4）修改程序代码时，一定要同时修改相关的注释，保持代码和注释的 同步。 （5）在实际的代码规范中，要求注释占程序代码的比例达到20%左右，即 100行程序中包含20行左右的注释。 （6）在程序块的结束行右方加注释标记，以表明某程序块的结束。 （7）避免在注释中使用缩写，特别是非常用缩写。 （8）注释与所描述内容进行同样的缩排，可使程序排版整齐，并方便注 释的阅读与理解