注釋規(guī)范

良好的編碼規(guī)范是程序員必備的素質(zhì)，編碼中的代碼注釋尤為重要，健全的代碼注釋可以提高代碼可讀性和維護(hù)性，不僅為了標(biāo)識此塊代碼的含義，很多時候包含了對業(yè)務(wù)邏輯的解釋，項(xiàng)目中難免有邏輯復(fù)雜之處，不加注釋的代碼，數(shù)日后自己看都會覺得陌生，更不要說其他人看了，今天分享一下Objective-C開發(fā)中常用的代碼注釋方式以及應(yīng)用場合。

注釋形式

注釋形式主要有：

單行注釋，多行注釋，方法注釋，方法集注釋（配合代碼塊實(shí)現(xiàn)快速注釋）

1. 單行注釋

使用 // 注釋單行代碼，最常見的使用場景是在方法內(nèi)注釋某個屬性或某塊區(qū)域的含義，如下圖：

2. 多行注釋

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

3. 方法注釋

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

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

使用該方法時顯示注釋內(nèi)容：

4：方法集注釋（配合代碼塊實(shí)現(xiàn)快速注釋）

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

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

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

實(shí)現(xiàn)方法：

( #pragma mark <#注釋的內(nèi)容#> )

但是每次敲這些字符一定不是你想要的效果，在Xcode8之前可以使用VVDocumenter增強(qiáng)版（個人在原基礎(chǔ)上修改添加方法集注釋功能），由于Xcode8默認(rèn)禁用使用插件，所以我們采用代碼塊+快捷鍵的方式來實(shí)現(xiàn)，效果也是酸爽：

上圖中，就是我使用代碼塊+快捷鍵來實(shí)現(xiàn)的方法集注釋，編寫方便，快捷，具體實(shí)現(xiàn)步驟如下：

添加代碼塊并設(shè)置快捷鍵：

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

記得代碼塊預(yù)設(shè)的時候“注釋內(nèi)容外要用<#>” 。