OC命名規範及代碼註釋規範

OC 命名規範及代碼註釋規範

    初級的開發者經常因變量過多，文件雜亂叫苦連天，其實計算機語言是人和計算機之間通信的媒介。好的代碼應該是就像人對計算機說話那樣，讓人看起來輕鬆易懂，規範的命名和代碼註釋可以幫助咱們減小bug，較好的和同事進行代碼交流。然而命名看似簡單的事，不少有經驗的程序員很難作到。在蘋果的SDK中有大量的API，就有不少咱們值得效仿的例子，如begin,,did,subtitle,adjustsImageWhenDisabled,adjustsImageWhenHighlighted等，所以對於程序開發語言的學習，較好的英語功底有很大優點。

 1.一些命名技巧  

程序中變量名儘可能用英文簡稱（禁止用拼音），如student簡寫爲stu，button簡寫爲btn。

定義對象動做的時候，若是即將發生用begin，正在進行用do，已經結束用did。

類命名的時候前面儘可能添加英文大寫前綴，對象後面可能是英文名字添加後綴。

2.普通註釋的寫法.

經常使用的註釋形勢有單行註釋（"//"）和多行註釋("/**/"),若是在代碼編寫時只是簡單地定義變量或者簡單聲明類和對象的時候可用單行註釋，若是註釋內容較多，則換取多行。

3.類或對象（協議、分類）的註釋

//聲明父類
@inertface person：NSObject

/*聲明子類
* 繼承自person
*/
@interface children :person

4.一些封裝好的函數或者代碼塊的註釋

/**
*打印hello world
**/
-(void)print
{
  NSLog(@"hello world");
}

/**打印輸出helloworld
*    含三個字符串參數
*/
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[]) {
    @autoreleasepool {
        NSString *str1=@"hello";
        NSString*str2=@"world";
        NSString*str3=[str1 stringByAppendingString:str2];
        NSLog(@"%@",str3);
    }
    return 0;
}

5.代理方法和數據源註釋方法

      #pragma  mark 用來註釋代理方法和數據源註釋方法,#pragma是一個預處理指令，用來設定編譯器的狀態或者指示編譯器完成一些特定的動做，#pragma相應的還有#pragma once（保證頭文件被編譯一次），#pragma hdrstop （表示預編譯的頭文件到此結束編譯），#pragma comment （該指令將一個註釋記錄放入一個對像文件或可執行文件中。

經常使用的lib關鍵字，能夠幫咱們連入一個庫文件。

每一個編譯程序能夠用#pragma指令激活或終止該編譯程序支持的一些編譯功能。例如，對循環優化功能：

1 #pragma loop_opt(on)//開始激活
2 #pragma loop_opt(off)//終止激活

在c語言編寫時，程序中會有些函數會使編譯器發出你熟知而想忽略的警告，如「Parameter xxx is never used in function xxx」，能夠這樣：

#pragma warn—100//Turnoffthewarningmessageforwarning#100
intinsert_record(REC*r)
{/*functionbody*/}
#pragma warn+100//Turnthewarningmessageforwarning#100backon

函數會產生一條有惟一特徵碼100的警告信息，如此可暫時終止該警告

相似 #pragma預編譯方法還有不少，就不列舉了。