代码注释风格应保持一致。
代码注释大致分为三类:
1.文档的注释
文档注释是对文档的内容及作用进行描述。每个文档注释都会被置于注释定界符/*...*/之中。该注释应位于
文档最前:
/**
* 说明这个
文档的一些信息...
* 说明这个文档的一些信息...
* 说明这个文档的一些信息...
* 说明这个文档的一些信息...
* 说明这个文档的一些信息...
**/
2.块的注释
块注释通
常用于提供对一整块内容的描述。块注释被置于每一块的开始及结尾处。
块注释之首应该有一个空行,用于把块注释和代码分割开来,比如:
//------这里是块开始 2012-12-11------
function writeMyName()
{
echo "David Yang";
}
//----块结束!-----
3.单条语句的注释
用注释界定符"//",可以注释掉整行或者一行中的一部分。
一般用在要进行注释的语句后面,如:
第一种:
error_reporting(E_ALL); //显示所有错误 注释php
第二种:
gfgfgfgfgfgf