实际项目中的代码规范

前言

最近在准备软件杯的比赛项目,因为是担任的是项目组长,所以要求组员之间的项目代码必须要有规范,方便组员之间的团队合作,以及后期代码的维护。而且,我相信,如果我们代码规范能够做好的话,对于我们的开发水平也会提高多少。

代码的规范化好处多多

  1. 规范的代码可以促进团队合作
  2. 规范的代码可以减少bug处理
  3. 规范的代码可以降低维护成本
  4. 规范的代码有助于代码审查
  5. 养成代码规范的习惯,有助于程序员自身的成长

开发前的准备

Eclipse中设置代码样式在 Window -->Preferences 中设置

设置工作空间编码为UTF-8

设置工作空间编码为UTF-8

设置文件编码为UTF-8

设置JAVA文件编码为UTF-8
设置XML文件编码为UTF-8

方法变量名转化成成员变量名称时,变量名称前加m以示区分

方法变量名转化成成员变量名称时,变量名称前加m以示区分

配置文档注释

Window -->Preferences -->Java -->Code Style -->Code Templates

Comments
Files修改成如下内容
/**   
 * @Title: ${file_name} 
 * @Package ${package_name} 
 * @Description: ${todo}(用一句话描述该文件做什么) 
 * @author Yangkai.Shen(此处换成你自己的名字,格式参考我的)
 * @date ${date} ${time} 
 * @version V1.0   
 */
Types修改成如下内容
/** 
 * @ClassName: ${type_name} 
 * @Description: ${todo}(这里用一句话描述这个类的作用) 
 * @author Yangkai.Shen(此处换成你自己的名字,格式参考我的)
 * @date ${date} ${time} 
 * ${tags} 
 */
Fields修改成如下内容
/** 
 * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么) 
 */
Constructors修改成如下内容
/** 
 * <p>Title: </p> 
 * <p>Description: </p> 
 * ${tags} 
 */
Methods修改成如下内容
/** 
 * @Title: ${enclosing_method} 
 * @Description: ${todo}(这里用一句话描述这个方法的作用) 
 * ${tags}  参数说明 
 * ${return_type}  返回类型 
 * @throws 
 */
Overriding methods修改成如下内容
/*
 * Title: ${enclosing_method}
 * Description: 
 * ${tags} 
 * ${see_to_overridden} 
 */
Delegate methods修改成如下内容
/** 
 * ${tags} 
 * ${see_to_target} 
 */
Getters修改成如下内容
/**
 * @return the ${bare_field_name}
 */
Setters修改成如下内容
/**
 * @param ${param} the ${bare_field_name} to set
 */
Codes中只修改New Java files
New Java files修改成如下内容
/**   
 * @Title: ${file_name} 
 * @Package ${package_name} 
 * @Description: ${todo}(用一句话描述该文件做什么) 
 * @author Yangkai.Shen(此处换成你自己的名字,格式参考我的)
 * @date ${date} ${time} 
 * @version V1.0   
 */

开发时的规范

  1. 每个方法前添加文档注释(快捷方式:选中需要添加的方法名,再按alt+shift+j)
  2. SVN提交代码时,必须注明提交代码时所作的修改
  3. 尽可能少的使用全局的静态变量,以免常驻内存
  4. 方法变量名转化成成员变量名称时,变量名称前加m以示区分(可以在eclipse中已经设置,自动化解决)
o(╯□╰)o我只要一毛钱的鼓励~~