1、注釋規范
- 良好的編碼規范是程序員必備的素質,編碼中的代碼注釋尤為重要,健全的代碼注釋可以提高代碼可讀性和維護性,
- 不僅為了標識此塊代碼的含義,很多時候包含了對業務邏輯的解釋,項目中難免有邏輯復雜之處,不加注釋的代碼,
- 數日后自己看都會覺得陌生,更不要說其他人看了,今天分享一下Objective-C開發中常用的代碼注釋方式以及應用場合。
2、注釋形式
- 注釋形式主要有:
- 單行注釋,多行注釋,方法注釋,方法集注釋(配合代碼塊實現快速注釋)
-
2.1 單行注釋
- 使用 // 注釋單行代碼,最常見的使用場景是在方法內注釋某個屬性或某塊區域的含義,如下圖:
- 使用 // 注釋單行代碼,最常見的使用場景是在方法內注釋某個屬性或某塊區域的含義,如下圖:
-
2.2 多行注釋
- 使用 /** 文本 **/ 的注釋格式(快捷鍵cmd+alt+/)可以對屬性和類以及方法進行注釋,與//不同的是,該注釋方式可以寫多行,一般使用在類的頭文件,多行介紹當前類的含義,如下圖:
- 使用 /** 文本 **/ 的注釋格式(快捷鍵cmd+alt+/)可以對屬性和類以及方法進行注釋,與//不同的是,該注釋方式可以寫多行,一般使用在類的頭文件,多行介紹當前類的含義,如下圖:
-
2.3 方法注釋
- 與方法2相同,使用 /** 文本 **/ 的注釋格式(快捷鍵cmd+alt+/)可以對方法進行注釋,快捷鍵會根據方法參數自動生成需要填寫的注釋內容,並且在其他地方使用該方法時,Xcode會智能提示出之前寫的注釋內容,如下圖:
- 在方法上方使用快捷鍵 cmd+alt+/:
- 使用該方法時顯示注釋內容:
-
2.4 方法集注釋(配合代碼塊實現快速注釋)
- 先介紹一下,何為方法集注釋,通常沒有添加方法集的類是這樣的:
- 為了快速定位類中的某塊代碼,或某個方法,Xcode為我們提供了方法集的注釋方式,可大大減少搜尋目標代碼的時間,如圖:
- 這樣就能對類中的方法和模塊一覽無余,要查找或修改的時候可以迅速定位,節省時間,提高自我體驗。
- 實現方法:
#pragma mark <#注釋的內容#>
- 但是每次敲這些字符一定不是你想要的效果,在Xcode8之前可以使用VVDocumenter增強版(個人在原基礎上修改添加方法集注釋功能),由於Xcode8默認禁用使用插件,所以我們采用代碼塊+快捷鍵的方式來實現,效果也是酸爽:
- 上圖中,就是我使用代碼塊+快捷鍵來實現的方法集注釋,編寫方便,快捷,具體實現步驟如下:
- 添加代碼塊並設置快捷鍵:
- 這樣就大功告成,保存代碼塊,在代碼中使用預設的快捷鍵,編譯器會自動提示,回車,輸入即可。
- 記得代碼塊預設的時候“注釋內容外要用<#>” 。
- 先介紹一下,何為方法集注釋,通常沒有添加方法集的類是這樣的: