目的：

  • 查找资源文件和变量时能够快速定位
  • 避免重名所带来的问题
  • 方便代码审查和修改，减少学习成本

原则：

  • 可以使用英文缩写，但不要杜撰出难以理解的缩写
  • 命名时参考已有的正确命名格式，使命名格式统一

实现规范

类名

  • 类名后缀表征类型，常用类型：Activity, Fragment, Service, Receive, Adapter, Manager…
  • 大驼峰命名法，如 MainActivity, HomeFragment

TODO:

  • 目前工程中混杂着Activity和Aty两种Activity类的后缀，后续统一用Activity作为后缀进行命名。
  • 用ADT重命名理论上是便捷安全的，不过要注意：1、替换前搜索重命名后的字段是否已经存在，2、替换后搜索重命名前的字段是否依然存在。

函数名

  • 函数名前缀表明动作，常用：initXXX, getXXX, setXXX, saveXXX, clickXXX, loadXXX, removeXXX…
  • 小驼峰命名法，如 initViews, getInstance
  • 命名但求清晰，无所谓名称长短（借鉴 Objective-C 的函数名）

变量

  • 小驼峰命名法
  • 名称要体现特征，以类型作为后缀，如 backBtn

常量

  • 均为大写字母，单词用下划线连接，如 MAX_WIDTH

资源文件(xml、图片资源等)

  • 均为小写字母，单词用下划线连接
  • 格式: <类型>_<...>_<状态>
  • 常用类型：activity, fragment, dialog, view, selector, btn, cell
  • 常用状态：normal, pressed, selected
  • 如: activity_main.xml, selector_login_submit.xml, btn_back_normal.png, cell_settings_rating_pressed.png
  • 命名需要提取特征，类型可以有多级，从大到小，考虑通用性和独有个性

XML中元素的命名

  • 包括标签中的name值，控件的id名称等
  • 均为小写字母，单词用下划线连接
  • 和资源文件一样，考虑通用性
  • 如: <color name="nav_title">#ffffffff</color> <string name="cart_hint_empty">购物车为空</string>

目前先列出这些，后续这些规则将不断完善。