Fork me on GitHub

411命名公约


全局公约:

  1. 不能以_(下滑线)、$(美元符号)开始或者结束
  2. 不能用中文、拼音+英文混搭, 尽量少使用纯拼音命名

局部公约:

  1. 类名:
    驼峰形式;
    (1)每个单词的首字母大写
    (2)格式: 标志+功能
    eg:MainActivity / UserDemo / XmlService / HttpUtil

  2. 方法名、参数名、成员变量、局部变量:
    驼峰形式;
    (1)首字母小写,其余每个单词首字母大写
    (2)格式没有硬性要求,一般是 v. / adj. + n.
    (3)减少下滑线的使用,除非命名太长
    eg:localValue / getHttpMessage() / inputUserId

  3. 常量名:
    (1)字母全部大写
    (2)每个单词之间用下滑线隔开
    eg:MAX_MATH_SCORE

  4. layout命名:
    (1)全部小写
    (2)每个单词间用下滑线隔开
    (3)分类:

    • .contentview命名(Activity默认布局):
      格式:activity_功能模块.xml
      eg:activity_main.xml、activity_more.xml
    • .Dialog命名:
      格式:dialog_描述.xml
      eg:dlg_hint.xml
    • .PopupWindow命名(自定义view):
      格式:view名_描述.xml
      eg:ppw _info.xml
    • . 列表项命名
      格式:list_描述.xml
      eg:list_city.xml
    • .包含项:
      格式:include_模块.xml
      eg:include_head.xml、include_bottom.xml
    • .adapter的子布局:
      格式:功能模块(属性)_item.xml
      eg:main_item.xml、

习惯规范

  1. 杜绝不规范的缩写,避免望文不知义。
    例如:AbstractClass -> AbsClass / condition -> condi /viewForPage -> view4Page