一.命名规范
1.1.命名原则
1.所有编程相关命名严禁使用拼音头字母缩写!
2.所有编程相关命名严禁使用不规范的英文缩写!
3.所有编程相关命名严禁使用拼音与英文混合的方式!
4.所有编程相关命名严禁使用下划线或美元符号开始,或者以下划线或美元符号结束!
1.2.包名
1.2.1.命名规则
1)小写
2)单数(包名单词统一使用单数形式)
3)点分隔符之间有且仅有一个自然语义的英语单词
1.2.2.命名首前缀
1)application(app):com(公司项目)
2)业务层module:项目名
3)底层library:library(底层类库)
1.2.3.命名顺序
1)application(app):com(公司项目).cnecloud(公司域名). power(项目名)
2)业务层module:power(项目名).module(业务层module).业务名
例如:power.module.warning;power.module.station;
3)底层library:library(底层类库).功能名
例如:library.base;library.common;
1.2.4.分包原则:高内聚性,模块化,低偶合。
用包来体现特性集。把所有相关某一特性(且仅特性相关)的项放入一个包中。这样包的内聚性高,模块化程度高,包之间偶合度低。紧密相关的项放在一起,没有分散到整个应用程序中。代码的所有权会更容易组织,也更容易被模块化,高复用性。
1.3.类名
1.3.1.命名规则
1)驼峰形式(UpperCamelCase)
2)特殊命名:(领域模型的相关命名)DO / DTO / VO / DAO等。
3)接口命名:以大写字母“I”开头,代表interface
4)抽象类命名:以“Abstract”或“Base”开头
5)实现类命名:以“Impl”/“Implement”结尾;或者以具体业务单词命名。