談談函數的命名規範

 最近在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