简述命名的礼仪

命名空间

时刻审视是否恰当的使用了「命名空间」, 保持较低的入侵性，降低冲突的可能性，不要给他人或将来的自己带来不便

避免重复表达

重复表达将使你的表达变得啰嗦, 试着精炼你的语言

反例: Clock.stopClock() 正例 Clock.stop()

尊重特定词汇的原本大小写

Beijing, URL, Java, JDK, GitLab, GitHub, Spring Cloud, jOOQ

以上书写，在注释和文档应保持原样

但在特定场景的命名规范中，也应注意转换:

• 大驼峰: Beijing, Url, Java, Jdk, Gitlab, Github, SpringCloud, Jooq
• 首字母大写 + 横线: Spring-Cloud

常见场景举例：

• 大驼峰: Java、JS、TS、Golang 等类型, Golang 方法等
• 小驼峰: 局部变量, 方法名等
• 全小写 + 下划线: 部分 API 字段命名规范
• 全大写 + 下划线: 枚举值, 常量, Error Code
• 全小写 + 横线: URL/URI 链接, Spring Boot 配置文件 (application*.yml)
• 首字母大写 + 横线: HTTP Header
• 首字母大写 + 空格: 标题, 菜单(项), Label, 特称
• 首单词首字母大写: 注释, 描述信息

扩展阅读

• 编程中「变量命名」词穷了怎么办？（Codelf）
• C语言的艺术之----标识符命令与定义
• 计算机变量命名常用词汇
• 编程常用动词细微差别