WHS GIS Engineer

Android 开发规范

2017-04-11
WHS

Android 命名规范根据平时开发经验总结,并参考阿里巴巴Java开发手册。

参考资料

阿里巴巴Java开发手册

(一)注释

  • 单行注释
	//注释说明
  • 块注释
	/**
	 * 注释说明
	 */

(二)命名规约

  • 包名

【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用 单数形式,但是类名如果有复数含义,类名可以使用复数形式。

正例: 应用工具类包名为com.alibaba.open.util、类名为MessageUtils(此规则参考 spring 的框架结构)

  • 类名

【强制】类名使用 UpperCamelCase 风格,必须遵从驼峰形式,但以下情形例外:(领域模型 的相关命名)DO / BO / DTO / VO等。

正例:MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion

反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

  • 方法名

【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵从 驼峰形式。

正例: localValue / getHttpMessage() / inputUserId

  • 常量

【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。

正例: MAX_STOCK_COUNT

反例: MAX_COUNT

  • 控件名

【强制】控件名统一使用 控件名简写_功能释义。

正例: Button btn_login ; TextView tv_title ; RecyclerView rcl_alarminfo

  • 资源文件命名

【推荐】矢量图使用ic_前缀

正例: ic_basemap

【推荐】 Button、RadioButon、ImageButton背景选择资源文件

正例: rb_oa_selector.xml


Similar Posts

Comments