iOS 註釋方法大全 代碼塊加快捷鍵註釋

註釋規範

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

註釋形式

註釋形式主要有：

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

1. 單行註釋

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

2. 多行註釋

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

3. 方法註釋

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

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

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

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

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

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

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

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

實現方法：

#pragma mark

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

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

添加代碼塊並設置快捷鍵：

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

記得代碼塊預設的時候“註釋內容外要用” 。