OC編碼規範

2021-07-30 05:32:32 字數 2897 閱讀 9860

一、命名規範

1.類:

(1)首字母大寫,後續單詞首字母大寫。

(2)類名末尾要包含此類的型別,比如rootview,rootviewcontroller。

2.屬性

(1)屬性名稱首字母小寫,後續首字母大寫;

(2)使用@property,要保持必要的空格,如:@property (nonatomic, strong)

;(3)如果在@implementation內宣告全域性變數,則使用下劃線字首,區域性變數不需要使用下劃線字首;

(4)禁止使用a、b、c這樣的變數命名,要見詞達意;

(5)屬性命名時,要將屬性型別編寫到屬性名中,使讀者看到變數名即可知道這是個什麼型別的變數,比如:usersdict,usersarray等。

3.方法:

(1)-或者+後加一空格;

(2)方法名首字母小寫,後續單詞首字母大寫;

(3)引數名首字母小寫,後續單詞首字母大寫;

(4)引數型別如果帶有*號,則引數型別和*號之間加一空格;

(5)如果方法太長、引數過多,可以換行冒號對齊,方法呼叫也一樣;

(6)非重寫系統方法時,不要使用is、set和get字首;

(7)可以使用can,should,will等詞來協助表達訪問方法的意思,但不要使用do和does;

(9)盡量讓方法的命名讀起來像一句完整的話,能夠傳達出方法的意思;

4.巨集定義:

巨集定義以k開頭,第二個字母大寫,後續單詞首字母大寫。

5.公共:

(1)單詞盡量通俗易懂,避免引起歧義,具體表述要和實際功能保持一致;

(2)除了廣為人知含義的縮寫,比如info、msg、ui、http這類以外,盡量不要使用單詞縮寫,要寫全拼,不要擔心方法太長,清晰最重要。

二、每一行的最大長度

在 xcode > preferences > text editing > page guide at column:中將最大行長設定為100,過長的一行**將會導致可讀性問題。

三、縮排和大括號

1.統一使用四個空格作為縮排。如果以tab來進行縮排控制,請在xcode中設定tab縮排為4個空格。

2.所有大括號另起一行。

3.在if判斷或者for迴圈中,就算僅有一行邏輯**,也不能省略大括號的使用。

四、注釋

1.注釋很重要,過多過少都不合適,不能沒有,也不能喧賓奪主。

2.變數、方法名前要加注釋加空行,不要使用後置注釋的方式。

3.方法內部,按照邏輯步驟分塊,每塊新增注釋;

4.除了方法內部第一條注釋以外,注釋上部保留一空行,避免**和注釋混為一片。

5.標頭檔案使用標準的多行注釋格式,實現檔案中僅使用雙斜槓注釋即可。

6.注意注釋是為了讓別人看懂,而不是僅僅你自己。

五、使用統一字首

1.乙個專案內根據實際意義定義字首;

2.專案內所有原始檔、資源檔案(包含)統一使用字首,避免專案間衝突;

3.原始檔內部的巨集定義同樣需要使用統一字首,如下;k +字首+ 實際意義;

六、類標頭檔案編寫規範

1.宗旨:標頭檔案是寫給使用者看的,在滿足使用者需求的前提下,標頭檔案元素越少越好,將沒有必要讓使用者看到的元素放到實現檔案中,這樣處理,能夠減少使用者的學習成本,而且減少使用錯誤率。

2.標頭檔案內容新增順序:

(1)版權注釋

(2)標頭檔案匯入

(3)巨集定義

(4)列舉定義

(5)協議定義

(6)類定義開始

(7)類所屬變數定義

(8)類所屬方法定義

(9)類定義結束

3.各個內容區之間都以一空行分割。避免**一大片混在一起。

4.如果方法太多,可以使用#pragma mark對**分區分塊,方便閱讀**。

七、類實現檔案編寫規範

1.實現檔案內容新增順序

(1)版權注釋

(2)標頭檔案匯入

(3)巨集定義

(4)靜態變數定義

(5)列舉定義

(6)類擴充套件定義開始

(7)類擴充套件的變數

(8)類擴充套件的方法

(9)類擴充套件結束

(10)類實現開始

(11)類實現方法

(12)類實現結束

2.各個內容區之間都以一空行分割。避免**一大片混在一起。

3.類全域性變數宣告方式:以@property方式新增到類擴充套件定義中,不在@implementation中定義全域性變數的方式。這樣處理可以統一使用self點操作,對於全域性變數的辨認度有大幅提高,

4.對於方法的封裝,有幾點規範:

(1)方法的單一職責:單個方法的職責盡量單一,盡量抽離公共邏輯,方法盡量復用。

(2)方法實現行數:乙個方法的最大行數100行,如果乙個方法的實現超過一百行,則說明需要進行邏輯拆分了。

(3)方法和方法之間要有一空行分割。

5.要使用#pragma mark將各個方法按照邏輯功能分割槽,公共方法單獨分割槽。方便閱讀和掌握**結構。

八、#pragma mark格式

使用"#pragma mark - 

內容"方式,此行上下都要留空行。

九、block編寫規範

1.除非必要,不要使用weakself。百分之九十九的情況不需要使用weakself,我們要自己維護好block的引用關係,讓block適時釋放。

2.跟之前大括號的規範一樣,block中的大括號也要另起一行,^保留在原行末尾。

3.如果block過於龐大,應該單獨宣告成乙個變數來使用。

php 編碼規範哪些 php編碼規範

1.php 必須以完整的形式來定界 即不要使用php 短標籤 且保證在關閉標籤後不要有任何空格。2.當乙個字串是純文字組成的時候 即不含有變數 則必須總是以單引號 作為定界符。例如 a example string 3.變數替換中的變數只允許用 變數名 的形式。例如 greeting hello n...

php 編碼規範哪些 PHP編碼規範

很多初學者對編碼規範不以為然,認為對程式開發沒有什麼幫助,甚至因為要遵循規範而影響了學習和開發的進度。或者因為經過一段時間的使用,已經形成了自己的一套風格,所以不願意去改變。這種想法是很危險的。如今的 web 開發,不再是乙個人就可以全部完成的,尤其是一些大型的專案,往往需要十幾人,甚至幾十人來共同...

php 編碼規範哪些 PHP 編碼規範

這是給小組制定的php編碼規範 該 php 編碼規範基本上是同 psr 規範的。有一部分的編碼規範 psr 中是建議,此編碼規範會強制要求。此編碼規範 是以 psr 1 psr 2 psr 2擴充套件 為藍本,並增加了相應的細節說明。通則基本編碼 php 必須使用 長標籤 或 短輸出標籤 一定不可使...