iOS團隊編碼規範

臭碼農發表於2017-12-14

不規範的程式碼,讀起來身心俱憊,改起來後患無窮。

命名原則:

1.最少字元,儘量的減少命名物件的長度,選擇字元少的名詞

2.名符其實,命名應該能直觀的描述被命名物件是什麼或者做什麼

3.避免歧義,儘量不要採用多義詞,也不要使用命名組合之後產生多義的方式

4.上下文一致,比如謂詞的統一性,如果都是集合類,那麼使用Remove表示刪除操作,那麼所有上下文就應該都用這個Remove,而不要再用Delete

5.少用縮寫,除非是很常見的縮寫或者專案中定義好的縮寫,否則不要使用縮寫

6.優先使用全域性常量而非巨集,應使用static方式宣告常量;

一、目錄命名

以功能模組劃分目錄,使用大駝峰法命名,例:Discovery,並關聯實體資料夾。

iOS團隊編碼規範

二、類命名

遵循命名原則,使用大駝峰法命名,通常在類的頭部.h檔案新增類註釋,標明該類的用途。

iOS團隊編碼規範

三、屬性命名

1. 一般變數名使用小駝峰命名規則,不要使用下劃線。

iOS團隊編碼規範

2. 類屬性變數用小駝峰法。

iOS團隊編碼規範

3. 類的成員變數用小駝峰命名法並加上下劃線開頭的方式命名。

iOS團隊編碼規範

四、方法命名

使用小駝峰法命名,方法名使用動詞短語,能具體表達出該方法的功能,參照系統方法:

iOS團隊編碼規範

更多編碼規範請參考:https://github.com/raywenderlich/objective-c-style-guide


註釋規範

連結到另一篇文章:iOS程式碼註釋方法大全,圖文介紹如何使用快速註釋

文章介紹各類註釋方法、應用場景,並搭配快捷鍵實現快速註釋。


以上屬於臭碼農原創,若有雷同屬巧合,如有錯誤望指正,轉載請標明來源和作者。by:臭碼農

相關文章