iOS項目編碼規范(三)表達式

表達式

1.IF語句

  • 表達式(if/else/switch/while等)和花括號總是在同一行打開,在新一行中關閉。
  • if語句如果沒有跟else,則可以不需要花括號。
if (isOpen) {
    // Do something
} else {
    // Do something else
}


if (isBad) return something;

2.SWITCH語句

花括號在case語句中不是必須的,但是當一個case語句中包含多行代碼時,大括號應該加上;
case的值不應該是魔法數字,應通宏定義、常量、枚舉等賦予具體意義。

    switch (tag) {
        case alertTag:
            // ...
            break;
        case buttonTag: {
            // ...
            // Muti-line code
            break;
        }
        default:
            // ...
            break;
    }

當switch的對象值是枚舉類型時,可以省略'default'語句。

typedef NS_ENUM(NSUInteger, EarnType) {
    EarnTypeChangePic = 1,          //換頭像
    EarnTypeChangeNick = 2,          //換昵稱
    EarnTypeChangeSchool = 3,        //換學校
};
...

    EarnType type;
    switch (type) {
        case EarnTypeChangePic: {
            // ...
            break;
        }
        case EarnTypeChangeNick: {
            // ...
            break;
        }
        case EarnTypeChangeSchool: {
            // ...
            break;
        }
    }

注意:XCode中有可以快速編寫switch語的插件點擊這里

注釋

由于Objctive-C自我描述性比較強,代碼中盡量少注釋,讓代碼能自我描述。不過需要注釋的地方,也不能省略,要清楚的解釋對應代碼含義或作用,杜絕無效注釋。
注釋也需要時常維護,保證最新。

幾類注釋

1.普通注釋

//注釋/*注釋*/類型的注釋,常用在代碼需要解釋的地方,或者暫時不使用的代碼塊。

// 注釋

/*
 ...
 大段注釋
 ...
 */

一個實例

    // 非當前審核版本顯示所有
    if ([reviewVersion compare:currentVersion] != NSOrderedSame) {
        return NO;
    }
    else {
        // reviewVersion=nil
        // reviewVersion 和 currentVersion一樣
        // 表示在審核
        return YES;
    }

注意:// 類型的注釋,在斜杠后空一格 商討

2.文檔注釋

可以用于生成文檔的注釋。
凡是以 ////**/*!開頭的注釋塊,都算所appledoc注釋。

/// 這是單行注釋。
 
/** 這也是單行注釋 */
 
/*! 同樣是單行注釋 */
 
/** 這也是單行注釋,
 *  第二行會接上第一行。
 */
  • 注釋塊中,每一行開頭的空格和*字符多數情況都會被appledoc忽略。
  • 連續的兩行(即沒有間隔空行)的注釋,將被合并成一個段落,并忽略換行,就像html。
  • 在注釋塊內,appledoc支持如下語法:Markdown、HTML、HeaderDoc Tags。

注意:寫文檔注釋可以使用XCode中的插件VVDocumenter-Xcode

3.標記注釋

用于在項目中作為標記的注釋,通常有以下四種:

//TODO: 用于預留接口或方法的標記。

//FIXME:用于標記BUG等需要修復的地方

//???:有疑問的代碼,可以用于review

//!!!:自定義說明

例如

if (isGood) {
    //TODO: 做好結果處理
}
else {
    //FIXME: BUG#3321 閃退,不能用0除
    return 8/0;
}

//???: 這是干嘛- -
a=a;

//!!!: 好思路,先標記下,我要寫到小本本里學習學習
x = 1;
y = 2;
x = x ^ y;
y = x ^ y;
x = x ^ y;
// x,y交互完成

注意:標記注釋可以和一個XCode的插件一起使用 XToDo

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

推薦閱讀更多精彩內容

  • Android編碼規范 源文件基礎 文件名 源文件以其最頂層的類名來命名,大小寫敏感,文件擴展名為.java。 文...
    呼呼哥閱讀 971評論 0 0
  • 作者:李旺成 時間:2016年4月3日 1. 前言 這份文檔參考了 Google Java 編程風格規范和 Goo...
    diygreen閱讀 39,951評論 19 224
  • [The Swift Programming Language 中文版]本頁包含內容: Swift提供了多種流程控...
    風林山火閱讀 577評論 0 0
  • 《番茄工作法》我的實踐,最開始去應用市場下各種版本的app試用,到現在哪個app都不再用,如果用app我總是想看看...
    波煙渺渺閱讀 121評論 0 0
  • 今天講兩個重度文字依賴癥患者的故事。當你點開這篇文的時候,如果找到自己的影子,沒關系。 1. 前幾天看到朋友在半糖...
    十一號井閱讀 716評論 0 0