註釋規範

      良好的編碼規範是程式設計師必備的素質，編碼中的程式碼註釋尤為重要，健全的程式碼註釋可以提高程式碼可讀性和維護性，不僅為了標識此塊程式碼的含義，很多時候包含了對業務邏輯的解釋，專案中難免有邏輯複雜之處，不加註釋的程式碼，數日後自己看都會覺得陌生，更不要說其他人看了，今天分享一下Objective-C開發中常用的程式碼註釋方式以及應用場合。

註釋形式

註釋形式主要有：

單行註釋，多行註釋，方法註釋，方法集註釋（配合程式碼塊實現快速註釋）

1. 單行註釋

使用 // 註釋單行程式碼，最常見的使用場景是在方法內註釋某個屬性或某塊區域的含義，如下圖：

2. 多行註釋

使用 /** 文字 **/ 的註釋格式（快捷鍵cmd+alt+/）可以對屬性和類以及方法進行註釋，與//不同的是，該註釋方式可以寫多行，一般使用在類的標頭檔案，多行介紹當前類的含義，如下圖：

3. 方法註釋

與方法2相同，使用 /** 文字 **/ 的註釋格式（快捷鍵cmd+alt+/）可以對方法進行註釋，快捷鍵會根據方法引數自動生成需要填寫的註釋內容，並且在其他地方使用該方法時，Xcode會智慧提示出之前寫的註釋內容，如下圖：

在方法上方使用快捷鍵 cmd+alt+/：

使用該方法時顯示註釋內容：

4：方法集註釋（配合程式碼塊實現快速註釋）

先介紹一下，何為方法集註釋，通常沒有新增方法集的類是這樣的：

為了快速定位類中的某塊程式碼，或某個方法，Xcode為我們提供了方法集的註釋方式，可大大減少搜尋目的碼的時間，如圖：

這樣就能對類中的方法和模組一覽無餘，要查詢或修改的時候可以迅速定位，節省時間，提高自我體驗。

實現方法：

#pragma mark  <#註釋的內容#>

但是每次敲這些字元一定不是你想要的效果，在Xcode8之前可以使用VVDocumenter增強版（個人在原基礎上修改新增方法集註釋功能），由於Xcode8預設禁用使用外掛，所以我們採用程式碼塊+快捷鍵的方式來實現，效果也是酸爽：

上圖中，就是我使用程式碼塊+快捷鍵來實現的方法集註釋，編寫方便，快捷，具體實現步驟如下：

新增程式碼塊並設定快捷鍵：

這樣就大功告成，儲存程式碼塊，在程式碼中使用預設的快捷鍵，編譯器會自動提示，回車，輸入即可。

記得程式碼塊預設的時候“註釋內容外要用<# 註釋內容 #>” 。