Objective-C 代碼規範(Code Style)

    咱們寫出來的代碼會給不少人看,爲了使代碼清晰簡潔,方便閱讀理解,都會統一聽從必定的代碼規範,Objective-C一樣如此。app

    主要參考規範:ide

    1.Google Objective-C Style Guidesvn

    2.Coding Guidelines for Cocoaui

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

    1.每行代碼最大長度爲100(C++的是80)spa

    

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

     

     調用方法時也是如此,參數都寫在一行或換行冒號對齊,代碼規範

     

    3.命名規則   code

     類名首字母大寫,方法首字母小寫,方法中的參數首字母小寫,同時儘可能讓方法的命名讀起來像一句話,可以傳達出方法的意思,同時取值方法前不要加前綴「get」xml

     

     變量名小寫字母開頭

      

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

     

    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能夠參考上一篇文章介紹。

    

    9.實例變量聲明時變量名前面加下劃線「_」,局部變量不用加。

    

    

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

    

    11.建議使用「#pragma mark」,方便閱讀代碼

    

    其餘詳細參考兩個規範說明,Coding Guidelines for Cocoa還列舉了詳細的命名要求。

相關文章
相關標籤/搜索