OC代碼規范

OC代碼規范

一、代碼格式

1.1、使用空格而不是制表符Tab

不要在工程里使用 Tab 鍵,使用空格來進行縮進。在 Xcode > Preferences > Text Editing 將 Tab 和自動縮進都設置為 4 個空格,因為在不同的編碼環境中,Tab鍵所設置的空格也會不一樣,比如有的是 2 個和 4 個空格。

1.2、每一行的最大長度

同樣的,在 Xcode > Preferences > Text Editing > Page guide at column: 中將最大行長設置為 80 ,過長的一行代碼將會導致可讀性問題

1.3、函數的書寫

一個典型的 Objective-C 函數應該是這樣的:

- (void)writeVideoFrameWithData:(NSData *)frameData timeStamp:(int)timeStamp {

...

}

在 - 和 (void) 之間應該有一個空格,第一個大括號 { 的位置在函數所在行的末尾,同樣應該有一個空格。

如果一個函數有特別多的參數或者名稱很長,應該將其按照:來對齊分行顯示:

-(id)initWithModel:(IPCModle)model

ConnectType:(IPCConnectType)connectType

Resolution:(IPCResolution)resolution

AuthName:(NSString *)authName

Password:(NSString *)password

MAC:(NSString *)mac

AzIp:(NSString *)az_ip

AzDns:(NSString *)az_dns

Token:(NSString *)token

Email:(NSString *)email

Delegate:? ? ? (id<IPCConnectHandlerDelegate>)delegate;

1.4函數調用

函數調用的格式和書寫差不多,可以按照函數的長短來選擇寫在一行或者分成多行:

//寫在一行

[myObject doFooWith:arg1 name:arg2 error:arg3];

//分行寫,按照 : 對齊

[myObject doFooWith:arg1

name:arg2

error:arg3];

以下寫法是錯誤的:

//錯誤,要么寫在一行,要么全部分行

[myObject doFooWith:arg1 name:arg2

error:arg3];

[myObject doFooWith:arg1

name:arg2 error:arg3];

//錯誤,按照首字母來對齊。

[myObject doFooWith:arg1

name:arg2

error:arg3];

1.5、@public和@private標記符

@public和@private標記符應該以一個空格來進行縮進:

@interface MyClass : NSObject {

@public

...

@private

...

}

@end

1.6、if,else,for應獨占一行

if (writeToFile) {

writeFileThread.interrupt(); }

if (j > 0 && j < 10) { ... // program code } else if (j >= 10 && j < 20) { ... // program code } else { ... // program code }

1.7、 不允許把多個短語句寫在一行中,即一行只寫一條語句。

//錯誤

titleButton.width = 150; titleButton.height = 30;

//正確

titleButton.width = 150;

titleButton.height = 30;

二、命名規范

基本原則

2.1 清晰

命名應該盡可能的清晰和簡潔,但在Objective-C中,清晰比簡潔更重要。Xcode會自動尋找類似的方法

2.2、一致性

在同一個模塊下或者派生類的時候,要遵循其基類或整體模塊的命名風格,保持命名風格一致性

2.3、使用前綴

在命名某個類的時候應加上公司的前綴,在必要的時候可以加上個人的名字縮寫。

2.4、命名方法

我們在方法命名時候,盡可能的把方法詳細的描述,便于自己或他人review。所以一般采用駝峰命名,而且都采用英文,千萬不要用拼音。。。

- (void)getImage {

...

}

2.5、命名代理

最標準的就是參照蘋果寫的代理方法

- (BOOL)tableView:(NSTableView *)tableView shouldSelectRow:(int)row;

2.6、 命名屬性

屬性的第一個字母小寫,后續單詞首字母大寫。

//名詞屬性

@property (nonatomic, strong) NSString *title;

//動詞屬性

@property (nonatomic, assign) BOOL showsAlpha;

2.7、 命名變量

左右空格

int a = 5 ;

double b = 5.5 ;

2.8、 宏的命名

宏必須全部都為大寫,并且用下劃線分開

#define SCREEN_WIDTH 320.0

2.9、 枚舉

枚舉類型的命名規則和函數的命名規則相同

//定義一個枚舉

typedef NS_ENUM(NSInteger, NSMatrixMode) {

NSRadioModeMatrix,

NSHighlightModeMatrix,

NSListModeMatrix,

NSTrackModeMatrix

};

三、注釋

我們有寫注釋的習慣,因為很多代碼我們要經常維護,所以有注釋維護代碼的效率會大大的提高

3.1、代碼注釋

方法、函數、類、協議、類別的定義都需要注釋,蘋果很多API都有注釋,它能讓我們更好的知道該方法的用途、功能,和如何實現的。

@property (nonatomic, readonly, strong, nullable)

UILabel *textLabel NS_AVAILABLE_IOS(3_0);

// default is nil.? label will be created if

necessary.

協議、委托的注釋要明確說明其被觸發的條件

/** Delegate - Sent when failed to init connection, like p2p failed. */

-(void)initConnectionDidFailed:(IPCConnectHandler *)handler;

3.2、 文件注釋

每一個文件都必須寫文件注釋,文件注釋通常包含

文件所在模塊

作者信息

歷史版本信息

版權信息

文件包含的內容,作用

參考項目剛創建的時候

四、編碼風格

4.1 盡可能不要用new方法

很多人用new代替alloc init,有時候內存會有問題。蘋果大多數都用alloc init,我們盡可能跟著蘋果的風格走。

五、個人建議

5.1 Delegate要使用弱引用

代理使用weak,不要用strong,容易循環引用

5.2 @class

在.h文件中盡量少引用某個類,一般我們只需要知道有這個類就可以了,所以我們都會用@class,因為用#import編譯器還會去編譯那個類

5.3 盡量使用self而不是下劃線

使用self可以觸發setter和getter,還可以區分成員變量

5.4 屬性暴露

定義屬性時候,如果其他類不會用到,盡可能寫在.m文件中,這樣不會暴露屬性

5.5 封裝

封裝是OC的三大特征之一,我們盡可能的把一個方法或者一個類封裝,這樣可以更好的提高開發效率。

5.6 MVC

在編碼過程中,我們必須采用MVC這種設計模式,必要的時候會采取MVVM。

5.7 設計模式的選擇

OC有20多種設計模式,能用代理盡量不要用通知,能用Block最好,單例視情況而定,因為單例會獨占一塊內存

5.8 文件的存放

一般我們會采用MVC,所以控制器放在C,模型放在M,一些視圖放在V。

5.9 引用框架的根頭文件

每一個框架都會有一個和框架同名的頭文件,它包含了框架內接口的所有引用,在使用框架的時候,應該直接引用這個根頭文件,而不是其它子模塊的頭文件

//正確,引用根頭文件

#import "Foundation/Foundation.h"

//錯誤,不要單獨引用框架內的其它頭文件

#import "Foundation/NSArray.h"

#import "Foundation/NSString.h"

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,327評論 6 537
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,996評論 3 423
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事?!?“怎么了?”我有些...
    開封第一講書人閱讀 177,316評論 0 382
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,406評論 1 316
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,128評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,524評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,576評論 3 444
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,759評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,310評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,065評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,249評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,821評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,479評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,909評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,140評論 1 290
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,984評論 3 395
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,228評論 2 375

推薦閱讀更多精彩內容