文章摘要: Java编程语言命名规范。
包名
- 全部小写:包名中的所有字母都应该是小写的,这是Java语言规范推荐的命名方式。
- 反向域名:包名通常采用反向域名的方式,这是为了在全球范围内保证包名的唯一性。这是因为域名本身就是唯一的,所以反向使用域名作为包名可以减少命名冲突的可能性。
- 点分隔:包名中的各个部分使用点(
.)分隔,每个点代表一层域名结构。 - 例如:
com.example.project
类名
- 大驼峰命名法(CamelCase)。
- 名字应该是一个名词,表示具体的对象或事物。
- 例如:
ChatAgent
接口名
- 大驼峰命名法(CamelCase)。
- 使用形容词、动词、名词来描述接口能够做什么。
- 例如:
ChatAgent
抽象类名
- 大驼峰命名法(CamelCase)。
- 在类名前加上
Abstract或Base作为前缀。 - 例如:
AbstractChatAgent、BaseChatAgent
抽象类名-实现
- 大驼峰命名法(CamelCase)。
- 名字应该是一个名词,表示具体的对象或事物。
- 例如:
ChatAgent
函数名
- 小驼峰命名法(camelCase)。
- 通常是一个动词或动词短语,表示该方法执行的操作。
- 例如:
chatAgent
变量名
- 小驼峰命名法(camelCase)。
- 名字应该是一个名词,表示变量所存储的值。
- 例如:
chatAgent
常量名
- 大蛇形命名法(SNAKE_CASE)
- 例如:
CHAT_AGENT
参数名
- 小驼峰命名法(camelCase)
- 例如:
chatAgent
注解名
- 大驼峰命名法(CamelCase)。
- 使用清晰明了的前缀。
- 例如:
@TestAgent
注释
- javadoc工具生成API文档的标签属性:Package-OracleJDK-终端命令-javadoc