其他开发规范

[jayjiahua]

除了遵循Git Flow工作流外，还要注意以下规范：

前端

1. 在页面中尽量避免使用内联样式,即style=”…”;
2. 重要图片必须加上alt 属性; 给重要的元素和截断的元素加上title
3. 给区块代码及重要功能加上注释, 方便后台添加功能，这里可以不规范注释，只要以中文标注即可
4. 充分利用无兼容性问题的html 自身标签及CSS 属性，充分考虑多浏览器的兼容性问题
5. 函数命名使用驼峰命名法
6. 在程序编写的开头部分写明此文件的作用及功能，常用的变量及函数的含义。在其他地方尽量减少注释的使用。
   • html 注释: 注释格式
   • css 注释: 注释格式 /* */
   • JavaScript 注释, 单行注释使用//，多行注释使用 /* */

后端

1. 函数命名使用驼峰命名法

2. 不要在程序中遗留注释掉的代码，在文档前及自己添加的函数前标注功能的描述，如下

   /** 
   * This is the model class for table "Users". 
   *
   * The followings are the available columns in table 'Users':
   * @property string $id
   * @property string $name
   *
   * 
   * 
   */
   

3. 将配置环境的方法写在readme上，以避免其他组员将大量时间花费在配置环境上。