下载掌阅APP，畅读海量书库
立即打开
专题讲座：光盘\MR\Video\4\代码注释.exe
视频速递：注释的几种使用格式
培养编写注释的习惯，对于一个程序员来说是很有帮助的，可以增强程序的可读性，便于程序员对程序的修改和后期维护。
PHP支持以下3种风格的程序注释。
（1）C++风格的单行注释“//”。
单行注释以“//”开始，到该行结束或者PHP标记结束之前的内容都是注释。
（2）Shell脚本风格的注释“#”。
Shell脚本注释以“#”开始，到该行结束或者PHP标记结束之前的内容都是注释。
（3）C风格的多行注释“/*……*/”。
C风格的多行注释以“/*”开始，以“*/”结束。与C语言相同，多行注释是无法嵌套的。
在下面的代码中，关闭标记“?>”之前的文本，“使用简短风格”是注释的一部分。而关闭标记之后的文本，“非注释内容”将被当作HTML，因为它在关闭标记“?>”之外。
HTML页面中可以加入相关的说明注释语句，便于源代码编写者对代码的检查与维护，还可以用于版权说明。这些注释语句并不会出现在浏览器的显示中。
语法：
或者
使用上述两种表示方法都可以实现注释语句。
例如，在网站页面中写入HTML注释语句，代码如下。
文字的排版标记对于HTML页面设计起到了不可忽视的作用。
程序注释是书写规范程序很重要的一个环节。注释主要针对代码的解释和说明，用来解释脚本的用途、版权说明、版本号、生成日期、作者、内容等，有助于对程序的阅读理解。
合理地使用注释有以下几项原则。
（1）注释语言必须准确、易懂、简洁。
错误的注释不但无益反而有害。
（2）注释在编译代码时会被忽略，不会被编译到最后的可执行文件中，所以注释不会增加可执行文件的大小。
（3）注释可以书写在代码中的任意位置，但是一般写在代码的开头或者结束位置。
避免在一行代码或表达式的中间插入注释，否则容易使代码的可理解性变差。
（4）修改程序代码时，一定要同时修改相关的注释，保持代码和注释的同步。
（5）在实际的代码规范中，要求注释占程序代码的比例达到20%左右，即100行程序中包含20行左右的注释。
防止没必要的重复注释信息。
（6）在程序块的结束行右方加注释标记，以表明某程序块的结束。
（7）避免在注释中使用缩写，特别是非常用缩写。
（8）注释与所描述内容进行同样的缩排，可使程序排版整齐，并方便注释的阅读与理解。