前言

代碼注釋對于一個(gè)開發(fā)者來說至關(guān)重要舔琅⊥胗玻可以很負(fù)責(zé)任的說，一個(gè)好的開發(fā)者一定要會(huì)寫一手漂亮的代碼注釋绵咱。我曾經(jīng)接手過一份一句代碼注釋都沒有的項(xiàng)目亿絮，我記得當(dāng)時(shí)每遇到一個(gè)Bug我都會(huì)問候一下寫這份代碼的前輩。所以好的代碼注釋技巧和好的代碼注釋工具是我們快速開發(fā)和維護(hù)的利劍麸拄。
我之前用的最好的代碼注釋插件是王巍寫的VVDocumenter派昧，這個(gè)插件應(yīng)該是當(dāng)年風(fēng)靡iOS程序圈的一款利器，它干凈拢切、美觀蒂萎、易懂，不幸的是蘋果在Xcode8.0之后屏蔽了所有第三方插件淮椰，讓我一度覺得以后的工作都不能好好注釋了五慈。好在蘋果在Xcode8.0之后增加了自己的代碼注釋體系，下面我就來總結(jié)一下Swift開發(fā)中那些注釋技巧主穗。

正文

學(xué)過Objective-C的人都知道泻拦，在Objective-C中的注釋跟大多數(shù)語言的注釋基本一致，然而蘋果在開發(fā)Swift語言的時(shí)候了采用新的注釋語句忽媒，更加人性化和通俗易懂争拐。

• Objective-C中的代碼注釋
  • 文件注釋
    1. 單行文件注釋

    // 這里寫注釋內(nèi)容 
    

    2. 多行文件注釋

    /*
     這里寫多行注釋內(nèi)容，這里的內(nèi)容可以很多可以無限制換行晦雨，可以把項(xiàng)目的一些版權(quán)信息
     和一些說明性信息寫在這種注釋里面架曹。
     */
    

  • 文檔注釋
    1. 單行文檔注釋

    /// 這里可以標(biāo)注單行文檔信息注釋
    

    2. 多行文檔注釋

    /**
     * 通過姓名隘冲、年齡、性別創(chuàng)建一個(gè)視圖并返回
     *
     * @param name   姓名
     * @param age    年齡
     * @param gender 性別
     * @return       創(chuàng)建好的視圖
     */
    - (UIView)studentWithName:(NSString *)name age:(int)age gender:(BOOL)gender {
    
    }
    

  • 地標(biāo)注釋

    1. pragma

       #pragma mark - UITableViewDelegate
       

       pragma注釋展示

    2. warning

    #warning 當(dāng)出現(xiàn)內(nèi)存警告的時(shí)候這里需要將內(nèi)存占有率高的變量釋放掉
    - (void)didReceiveMemoryWarning {
      [super didReceiveMemoryWarning];
      // Dispose of any resources that can be recreated.
    }
    

    warning警告展示
    
    

    這種警告提醒方式不得不說對于有強(qiáng)迫癥的程序員來說實(shí)在是太不友好了绑雄，分分鐘都想把它刪掉展辞，甚至有時(shí)候做項(xiàng)目的時(shí)候一天可能來來回來要看上它幾百遍，本人極少會(huì)使用到這種方式注釋代碼万牺。

• Swift中的代碼注釋

  • 文件注釋

    1. 單行文件注釋

    // 這里寫注釋內(nèi)容
    

    2. 多行文件注釋

    /*
      這里寫多行注釋內(nèi)容罗珍，這里的內(nèi)容可以很多可以無限制換行，可以把項(xiàng)目的一些版權(quán)信息
      和一些說明性信息寫在這種注釋里面脚粟。
     */
    

  • 文檔注釋

    1. 單行文檔注釋

    /// 這里寫注釋內(nèi)容 
    

    2. 多行文檔注釋

    /// 通過姓名靡砌、年齡、性別創(chuàng)建一個(gè)視圖并返回
    ///
    /// - Parameters:
    ///   - name:   姓名
    ///   - age:    年齡
    ///   - gender: 性別
    /// - Returns:  創(chuàng)建好的視圖
    func student(name : String, age : Int, gender : Bool) -> UIView {
      
    }
    

  • 地標(biāo)注釋

    1. MARK:

    // MARK: UITableViewDelegate
    

    MARK地標(biāo)注釋展示Xcode9.0效果
    2. TUDO:

    //TODO:進(jìn)入這個(gè)方法表示已接收到內(nèi)存警告珊楼，需要做出處理
    override func didReceiveMemoryWarning() {
         super.didReceiveMemoryWarning()
         // FIXME:這里做出修改
     }
    

    TUDO注釋效果展示
    3. FIXME:

    override func didReceiveMemoryWarning() {
        super.didReceiveMemoryWarning()
        // FIXME:這里做出修改
    }
    

    FIXME:注釋展示
    
    

    Swift的提醒注釋做的更加人性化也更加美觀通殃，并且從快速跳轉(zhuǎn)區(qū)可以很直觀的看出來代碼的結(jié)構(gòu)。最重要的是它的提醒警告注釋不會(huì)出現(xiàn)黃色警告標(biāo)識厕宗，這對于我這種重度強(qiáng)迫癥真的是福音画舌。
    Swift注釋不會(huì)出現(xiàn)警告提醒！
    Swift注釋不會(huì)出現(xiàn)警告提醒已慢！
    Swift注釋不會(huì)出現(xiàn)警告提醒曲聂！
    重要的事情說三遍！Ｓ踊荨Ｅ笠浮！膜楷！