## 前端 前端主要包括HTML、CSS、JS 三个模块，分别遵循相关的代码规范 * HTML 遵循HTML5 * CSS 遵循CSS3 * JS 遵循ES6 ## 后端 微信插件采用WeiPHP 框架，WeiPHP 基于ThinkPHP，遵循PHP 代码规范 ## 注释 **一般情况下，后台代码（PHP）代码注释率不得低于30%，且注释掉的代码不包含在注释之内。** **若前端含有JS代码，前端代码注释率不得低于30%，且前端代码的注释规则和后端代码类似。** 每个函数、功能模块都应有相应的注释，简要说明函数的功能和作用，调用方法，需要传入的参数，返回值，注释格式如下： ``` /* * 函数功能描述 * @param string $var1 变量1 * @param intger $var2 变量2 * @param array $var3 变量3 * @return string $res 返回值 * @author XXX-wyx (xxx@sina.com) */ ``` 对于特殊的功能代码，需加入注释说明 ~~~ // 根据输入字符串生成md5码 $md5Str = md5(inputStr); ~~~ 对于晦涩难懂的算法，则加入多行注释对算法进行说明 ~~~ /* * 图像识别算法 * 算法描述 * ........ * ........ */ $img = new Image(); ........... ........... ~~~ ## 其他 每个函数模块完成一个功能，注意模块代码的长度。每个模块代码保持在50 行以下，保证代码的可读性。注意模块的内聚性，以及和其他模块间的耦合性。做到高内聚低耦合。