Objective-C 代碼規范(Code Style)


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

    主要參考規范:

    1.Google Objective-C Style Guide

    2.Coding Guidelines for Cocoa

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

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

    

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

     

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

     

    3.命名規則   

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

     

     變量名小寫字母開頭

      

     常量以小寫字母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 還列舉了詳細的命名要求。

    


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM