Android开发规范

一、命名

包命名格式

包名采用域后缀倒置的加上自定义的包名,采用小写字母。

  • com.公司名.产品名.模块名称

类和接口命名

命名必须使用驼峰规则,即每个英文单词的首字母使用大写、其余字母使用小写的大小写混合法。

示例:ChatActivity, LogManager, LogConfig

常用组件类的命名以组件名加上组件类型名结尾。

示例:

  • Application 类型的,命名以Application 结尾——MTApplication
  • Activity类型的,命名以Activity结尾——LoginActivity

方法命名

方法名是一个动词,采用大小写混合的方式,第一个单词的首字母小写

示例:

public void addNewOrder();

方法中,存取属性的方法采用set 和 get方法

示例:

public void setVisible(boolean);
public String getType(); 

属性名

第一个单词的字母使用小写,剩余单词首字母大写其余字母小写的大小写混合法。
示例:

private customerName;
private orderNumber; 

常量名

常量名使用全大写的英文描述,英文单词之间用下划线分隔开,并且使用 static final修饰。

示例:

public static final int MAX_VALUE = 1000; 

layout 命名

全部单词小写,单词间以下划线分割

示例:

person_login.xml

id 命名

layout 中所使用的id必须以全部单词小写,单词间以下划线分割。

示例:

 @+id/book_name_show
 @+id/book_name_edit

资源命名

命名必须以全部单词小写,单词间以下划线分割。

示例:

home_icon_username.png
home_icon_confirm.png 

二注释

文件注释

示例:

/*
* 文件名
* 包含类名列表
* 版本信息,版本号
* 创建日期。
* 版权声明
*/

类注释

/**
* 〈功能详细描述〉
* @version [版本号, 创建时间]
* @author [作者](必须)
* @see [相关类/方法](可选)
* @since [产品/模块版本] (必须)
*/

方法注释

/**
*功能
* @param 
* @return 
*/

评论

Your browser is out-of-date!

Update your browser to view this website correctly. Update my browser now

×