Java命名规范

  1. 包名

    多单词组成时每个单词首字母小写，xxxyyyzzz

  2. 变量名

    • 多单词组成时第一个单词首字母小写，第二个单词开始每个单词首字母大写xxxYyyZzz

    • 不要包含List、import、java等类名、关键字或特殊字；

    • 少使用字母o与数字0，字母l与数字1等

    • 避免冗余，不要出现Variable、表字段中避免出现table、字符串避免出现nameString

    • 使用驼峰命名法，尽量使用完整的单词

    • 一些常量，最好不直接使用数字，而指定一个变量名，这个变量名可以便于搜索到

  3. 类名

    • 多单词组成时所有单词首字母大写，XxxYyyZzz
    • 类名与对象名应该是名词与名词短语，如Customer、WikiPage、Account和AddressParser
    • 避免使用Data或Info这样的类名
    • 避免使用动词。比如：Manage、Process

  4. 方法名

    • 方法名应当是动词或者动词短语，如postPayment、deletePage或save
    • 多单词组成时第一个单词首字母小写，第二个单词开始每个单词首字母大写xxxYyyZzz

  5. 常量名

    • 多单词组成时所有单词字母大写，每个单词间使用下划线链接，XXX_YYY_ZZZ
    • 一些常量，最好不直接使用数字，而指定一个变量名，这个变量名可以便于搜索到

  6. 其他

    • 项目中同时出现controllers与managers，为什么不统一使用其中一种，不要出现同一个意思的多个词引起歧义
    • 名字不要带有项目的缩写，这样完全没有必要
    • 使用解决方案领域名称或使用源自所涉问题领域的名称

参考文献

  • 《代码整洁之道》：Robert C. Martin, Principles, Patterns, and Practices of Agile Software Development, Upper Saddle River, NJ: Prentice Hall, 2002.