天天看點

Objective-C 代碼規範(Code Style)

我們寫出來的代碼會給很多人看,為了使代碼清晰簡潔,友善閱讀了解,都會統一遵從一定的代碼規範,Objective-C同樣如此。

    主要參考規範:

    簡單總結一下目前接觸到的:

    1.代碼行度最大為100列(C++的是80)

     2.聲明類或方法時,注意空格的使用,參數過多時可換行保持對齊,

Objective-C 代碼規範(Code Style)

     調用方法時也是如此,參數都寫在一行或換行冒号對齊,

Objective-C 代碼規範(Code Style)

    3.命名規則   

 類名首字母大寫,方法首字母小寫,方法中的參數首字母小寫,同時盡量讓方法的命名讀起來像一句話,能夠傳達出方法的意思,同時取值方法前不要加字首“get”

Objective-C 代碼規範(Code Style)

     變量名小寫字母開頭

Objective-C 代碼規範(Code Style)

     常量以小寫字母k開頭,後續首字母大寫

Objective-C 代碼規範(Code Style)

    4.關于注釋

 注釋很重要,但除了開頭的版權聲明,盡可能把代碼寫的如同文檔一樣,讓别人直接看代碼就知道意思,寫代碼時别擔心名字太長,相信Xcode的提示功能。

5.執行個體變量應該在實作檔案.m中聲明或以@property形式在.h檔案中聲明,一定要直接在.h檔案聲明,加上@priavte,另外,使用@private、@public,前面需要一個縮進空格。

    6.盡可能保證 .h檔案的簡潔性,可以不公開的API就不要公開了,寫在實作檔案中即可。

    7.Xcode支援Objective-C/C/C++混編,是以引用頭檔案時:#import

Ojbective-C/Objective-C++頭檔案(Objective-C++是Objective-C與C++混編的檔案),#include

C/C++頭檔案。

8.寫delegate的時候類型應該為weak弱引用,以避免循環引用,當delegate對象不存在後,我們寫的delegate也就沒有存在意義了自然是需要銷毀的,weak與strong可以參考上一篇文章介紹。

Objective-C 代碼規範(Code Style)

    9.執行個體變量聲明時變量名前面加下劃線“_”,局部變量不用加。

Objective-C 代碼規範(Code Style)
Objective-C 代碼規範(Code Style)

    10.使用Block時,内容四個空格縮進,“^”後帶有參數時,參數與“{”之間有一個空格縮進

Objective-C 代碼規範(Code Style)

    11.建議使用“#pragma mark”,友善閱讀代碼

    其他詳細參考兩個規範說明, 還列舉了詳細的命名要求。