Xcode作為iOS的開發神器，為我們提供了十分豐富的文檔提示功能，在開發過程中，我們可以十分方便的按下Option鍵，選中一個類或者方法查看其文檔說明。而實際開發過程中我們也可以使用規范的方法添加注釋，達到這樣的效果。本篇主要介紹幾種常用的文檔注釋方法。
一、多行注釋文檔
/**
多行注釋文檔相比于普通多行注釋多了一個星號。
在這里可以使用markDown語法，書寫各種提示信息
如：顯示一個有序列表
1. 有序列表
2. 有序列表
3. 有序列表
*/
多行注釋文檔效果圖
我們發現一個問題，效果圖中前兩行并沒有換行，我們若是希望換行就需要在之間添加一個空行
二、單行注釋文檔
///# 標題1
///## 標題2
///hello oc，下面的空行是為了換行
///
///hello swift
/// - 這里使用了無序列表
/// - 使用加粗 **this**， 使用斜體 _this_
/// - 添加一個鏈接: [百度](http://www.baidu.com)
/// - 添加一個圖片:
單行注釋文檔效果圖
三、方法/函數的注釋
方法的注釋包括傳入參數、返回值、和異常等說明
///- Parameters:
/// - value1: 第一個傳入參數
/// - value2: 第二個傳入參數
///- Returns: 返回值的說明
///- Throws : 出現異常的說明
func doSomeThing(value1:String, vaule2:String, value3:String)->String{
return "testStr"
}
方法/函數的注釋效果圖
四、源信息注釋
這里是提供代碼的作者，版權相關說明
///- Author: zs
///- 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: 一些評論心得
算法注釋x效果圖
