最近在Review團隊部分同學的程式碼，梳理目前系統對外暴露的API情況，心裡有一些感觸，結合自己過去的一些心得體會，簡單聊一下程式碼中函式或者API介面的命名規範。
1. 拼寫要準確
無論是使用英文單詞還是拼音，一定要注意拼寫的正確性，典型的錯誤例如“creatTime”，我確實不太能忍（即便我不是處女座）。特別是對外發布的API的名字命名，一定不能錯，否則一旦釋出就不方便改了，要保持相容性。而且由於是提供給外部團隊使用，拼寫錯誤也會給使用者帶來不便。
2. 使用正常的時態
這一點平時提到的人不多，但是我個人是比較看重的，特別是程式碼中狀態的變數或者函式的命名，比如 onXxxxStarted 表示xxx已經啟動了，isConnecting表示正在連線。正確的時態可以給使用者傳遞準確的資訊。
3. 函式和屬性的命名是有區別的
如果是函式，建議使用動賓結構
動賓結構就是 doSomething，這樣的函式命名含義明確
比如： openFile, setName, addNumber...
如果是屬性命名，建議使用定語+名詞
比如 fileName, maxLength, textSize
5. 不要單詞+拼音混合使用
比如：useJiFen，huKouNumber.. 缺乏美感不說，可讀性大幅度降低。
6. 謹慎使用縮寫
除非是約定俗成已經被廣泛使用的縮寫，否則老老實實用完整拼寫。
典型的反面例子: count->cnt, manager->mgr password->pwd button->btn
無論我們使用eclipse 或者intellij, 都有很好的自動完成功能，名字長一點沒關係的，可讀性更重要。
簡單的說，我們在命名的時候，需要站在使用者的角度去思考，API設計也要講究使用者體驗。好的API設計應該是符合直覺，能望文生義的，讓使用者能用盡量簡潔的程式碼完成呼叫。
掃描二維碼或手動搜尋微信公眾號【架構棧】： ForestNotes