Android

 编程规范

本编程规范参考

Code Style Guidelines for Contributors 整理，如有错

误，欢迎完善。

 

一 注释规范

1.

类、接口注释的内容

1、用途。开发人员使用某个类/接口之前，需要知道采用该类/接口的用途
2、开发维护的日志。一个有关于该类/接口的维护记录：时间、作者、摘要。

Eclipse 代码格式化：
位置：
Window › Preferences › Java › Code Style>Code Template >Code>
New Java files
内容：
${filecomment}
${package_declaration}
/** 
 * 

   

类说明：

 * @author  Liucd
 * @date    ${date}
 * @version 1.0
 */ 
${typecomment}
${type_declaration}

2.

方法注释的内容

1、该方法是做什么的 。
2、传入什么样的参数给这个方法。@param
3、异常处理。@throws
4、这个方法返回什么。@return

 

二 命名规范

命名规范的目的是使程序更易读。它们也可以提供一些有关标识符功能的

信息，以助于理解代码，不论它是一个常量、包、还是类。

应该尽量做到以下几点：使用完整的英文描述来命名；避免命名超长（

15 

个字符以内比较好）；避免相似的命名，例如：

persistentObj 和

persistentObjs 不要一起使用；anSqlStmt 和 anSQLStmt 不要一起使用；
慎用缩写，如果要用到缩写，则按照缩写规则使用缩写，例如：

No.代表

number 数字，ID.代表 identification 标示。下面分类介绍命名规范。

1.

包
包名小写
import com.founder.mobile.common

2.

类

/接口