Xcode作為iOS的開發神器，為我們提供了十分豐富的文件提示功能，在開發過程中，我們可以十分方便的按下Option鍵，選中一個類或者方法檢視其文件說明。而實際開發過程中我們也可以使用規範的方法添加註釋，達到這樣的效果。本篇主要介紹幾種常用的文件註釋方法。

多行註釋文件

/**
    多行註釋文件相比於普通多行註釋多了一個星號。
    在這裡可以使用markDown語法，書寫各種提示資訊
    如：顯示一個有序列表
    1. 有序列表
    2. 有序列表
    3. 有序列表
*/

我們發現一個問題，效果圖中前兩行並沒有換行，我們若是希望換行就需要在之間新增一個空行

單行註釋文件

 ///# 標題1
    ///## 標題2
    ///hello oc，下面的空行是為了換行
    ///
    ///hello swift
    /// - 這裡使用了無序列表
    /// - 使用加粗 **this**， 使用斜體 _this_
    /// - 新增一個連結: [百度](http://www.baidu.com)
    /// - 新增一個圖片:![swift picture](http://img0.imgtn.bdimg.com/it/u=14209024,814391630&fm=21&gp=0.jpg )

方法/函式的註釋

方法的註釋包括傳入引數、返回值、和異常等說明

     ///- Parameters:
 

    ///     - value1: 第一個傳入引數
    ///     - value2: 第二個傳入引數

    ///- Returns: 返回值的說明
    ///- Throws : 出現異常的說明
    func doSomeThing(value1:String, vaule2:String, value3:String)->String{
        return "testStr"
    }

源資訊註釋

這裡是提供程式碼的作者，版權相關說明

    ///- Authors: 開發人員 zs, cf
    ///- CopyRight: 版權資訊
    ///- Date: 15 July 當前開發時間
 

    ///- Since: iOS 8.0
    ///- Version: 2.26

標籤註釋

標籤註釋穿插在我們程式碼的任意位置，我們通過xcode的類檢視來查詢標籤，可以快速定位，十分方便，常見的三種註釋標籤如下：

    //MARK: - 在程式碼的某處新增一個標籤，可以使檢視類檢視更加方便
    //TODO: - 將來可能會繼續編輯的部分
    //FIXME: - 將要修改的部分

演算法註釋

演算法是相對比較複雜的方法，我們通過註釋對其進行詳盡的說明，其文件註釋使用的關鍵字如下：

    /// - Precondition: 前置條件
    /// - Postcondition: 後置條件
    /// - Requires:  演算法需要的資訊
    /// - Invariant:  迴圈不變數
    /// - Complexity: 複雜度
    /// - Important: 描述重要資訊
    /// - Warning:  描述警告資訊
    /// - Attention: 描述注意事項
    /// - Note:  一些記錄
    /// - Remark:  一些評論心得