编码风格

1. 注释  (用这种统一风格的注释， 类，成员变量，函数全部写注释， 一些可以从上下文得到含义的描述要写得精简一些)

准则:

1. 简单的自说明的代码，不需要繁琐的注释 （例如一些Extra Method, 允许没有注释或者一行提示功能的注释， 参数说明可以不要）

 

 

类

/**

 * 类描述

 *

 *  @author

 *　　　　作者

 *

 * @version

 * 　　　　版本

 *  日志:

 * 　　　　xxxx

 */

 

成员变量

/** 描述 */

xxxxx 

 

函数

/**

 * 函数描述

 *

 * @param xxx

 * 　　　　描述

 *

 * @param yyy

 *　　　　描述

 *

 * @return

 *　　　　描述

 */

 

没有参数和返回值的函数，如果单行可以注释的

/** 描述 */

 

 

函数内部的代码

// 描述

xxxxxxxxx

 

// 描

// 述

yyyyyyyy

 

2. 类中成员变量和函数位置 (JAVA)

常量最前面

静态变量

成员变量

构造函数

变量访问函数

功能函数