命名空間
時(shí)刻審視是否恰當(dāng)?shù)氖褂昧恕该臻g」, 保持較低的入侵性，降低沖突的可能性，不要給他人或?qū)?lái)的自己帶來(lái)不便
避免重復(fù)表達(dá)
重復(fù)表達(dá)將使你的表達(dá)變得啰嗦, 試著精煉你的語(yǔ)言
反例:
Clock.stopClock()正例Clock.stop()
尊重特定詞匯的原本大小寫(xiě)
Beijing, URL, Java, JDK, GitLab, GitHub, Spring Cloud, jOOQ
以上書(shū)寫(xiě)，在注釋和文檔應(yīng)保持原樣
但在特定場(chǎng)景的命名規(guī)范中，也應(yīng)注意轉(zhuǎn)換:
- 大駝峰: Beijing, Url, Java, Jdk, Gitlab, Github, SpringCloud, Jooq
- 首字母大寫(xiě) + 橫線: Spring-Cloud
常見(jiàn)場(chǎng)景舉例：
- 大駝峰: Java、JS、TS、Golang 等類(lèi)型, Golang 方法等
- 小駝峰: 局部變量, 方法名等
- 全小寫(xiě) + 下劃線: 部分 API 字段命名規(guī)范
- 全大寫(xiě) + 下劃線: 枚舉值, 常量, Error Code
- 全小寫(xiě) + 橫線: URL/URI 鏈接, Spring Boot 配置文件 (application*.yml)
- 首字母大寫(xiě) + 橫線: HTTP Header
- 首字母大寫(xiě) + 空格: 標(biāo)題, 菜單(項(xiàng)), Label, 特稱(chēng)
- 首單詞首字母大寫(xiě): 注釋, 描述信息
