如何给项目命名?想必各位 coder 都常为此苦恼不已。这里我稍微整理了一下几个比较规范的命名规则,主要还是自己看啦!

欢迎大家补充哦 :-)


一、项目名

全部小写,比如 cms、workdesk、jobserver 等

二、java相关命名

  1. 类命名:每音节单词前的第一个字母大写,比如 FieldInfo、Expression 等

  2. 普通变量(包括spring里的变量引用命名):第一个单词前小写,以后每个单词第一个字母大写,比如:password、primaryFlag

  3. 静态变量:全部大写,多个单词则以_分开,比如BOOLEAN_FLAG

  4. 包package命名:全部小写,比如 com.joinspider.workdesk

  5. 类名、变量名是名字组合,多名词顺序和中文顺序一样,比如 ScriptEngine

  6. 属性也可以是形容词 + 名词

  7. 常量可使用上述规则,如果为了体现多个常量是一组的概念,也可以被修饰前置,比如:VAR_START,VAR_END.

  8. 方法是动词 + 名字或者只有动词

  9. Import 需要指出 import 哪一个类,禁止 import 整个 package

    import java.util.*; //错误
    
    import java.util.HashMap; //正确
    
  10. Test Class 名的格式为“测试对象 Class 名 **+ Test **”

  11. 进行测试或 Package 测试的所有的 Class 名的格式为“**AllTest **”或“Package 名 + Test

  12. 生成 Object 的 Method 名的格式是“**“create” + **Object 名”

  13. 转换 Method 名的格式是““to” + Object 名”

  14. 在查询方法中应使用find作为前缀

三、属性文件.properties定义变量命名

object.a_b_c 格式,全部小写,其中 object 是宿主,a_b_c 多个单词下划线分开。

例:hibernate.cache.use_second_level_cache、hibernate.cache.provider_class、hibernate.cache.provider_configuration_file_resource_path

四、xml 文件命名

全部小写,-符号是其 xml 的用途说明,类似 applicationContext 属习惯命名。比如 springmvc-servlet.xml、workdesk-manager.xml、workdesk-servlet.xml、applicationContext-basic.xml 等 xml里的内容多个字符间以-隔开,比如 param-name、filter-mapping等

五、普通文件命名( jsp, js, img 等)

和 Java 普通变量规范相同

六、属性文件 properties

以下划线隔开:errors_zh_CN.properties,hibernate_test.properties

七、数据库命名:

表、字段命名全部大写,多个单词以_隔开

八、包名命名规范

我们知道,一般公司命名为“com.公司名.项目名.模块名…”。

这里事实上 “com” 代表的是该公司的域名。

除了 com 之外,域又分为 org、com、cn 等等许多,其中 org 为非营利组织,com 为商业组织。

如果没有域名的话,你可以以自创的独一无二的域名开头,最重要的其实是防止发生冲突。


参考

[1] https://blog.csdn.net/weixin_42618873/article/details/90694514

[2] https://blog.csdn.net/youyaecho/article/details/51179023