PHP编码规范之注释和文件结构说明

文件结构 |――images
|――include
　　|――parameter
　　|――config
　　|――function
|――index
images存放图片文件，include中是系统是要引用的文件，一般在parameter中存放参数文件，config中存放配置文件，function中存放方法文件，如javascript的方法等，并按功能模块的分类，将各功能的类也放入其中
文件名
文件夹命名一般采用英文，长度一般不超过20个字符，命名采用小写字母。除特殊情况才使用中文拼音，一些常见的文件夹命名如：images(存放图形文件)，flash（存放Flash文件），style(存放CSS文件)，scripts（存放Javascript脚本），inc(存放include文件)，link（存放友情链接）,media(存放多媒体文件)等。文件名称统一用小写的英文字母、数字和下划线的组合。
块注释
块注释通常用于提供对文件，方法，数据结构和算法的描述。块注释被置于每个文件的开始处以及每个方法之前。它们也可以被用于其他地方，比如方法内部。在功能和方法内部的块注释应该和它们所描述的代码具有一样的缩进格式。
块注释之首应该有一个空行，用于把块注释和代码分割开来，比如：
/
　 这里是块注释
/
块注释可以以/-开头，这样indent(1)就可以将之识别为一个代码块的开始，而不会重排它。
/-
　 如果想被忽略，可是使用特别格式的块注释
　
　 one
　 　　two
　 　　　　three
　/
注意：如果你不使用indent(1)，就不必在代码中使用/-，或为他人可能对你的代码运行indent(1)作让步。
单行注释
短注释可以显示在一行内，并与其后的代码具有一样的缩进层级。如果一个注释不能在一行内写完，就该采用块注释。单行注释之前应该有一个空行。以下是一个代码中单行注释的例子：
if (condition) {
　　/ 以下代码运行的条件 /
　　...
}
尾端注释
极短的注释可以与它们所要描述的代码位于同一行，但是应该有足够的空白来分开代码和注释。若有多个短注释出现于大段代码中，它们应该具有相同的缩进。
以下是一个代码中尾端注释的例子：
<div class="codetitle"><a style="CURSOR: pointer" data="60299" class="copybut" id="copybut60299" onclick="doCopy('code60299')"> 代码如下: