注釋規(guī)范
良好的編碼規(guī)范是程序員必備的素質(zhì)衬衬,編碼中的代碼注釋尤為重要,健全的代碼注釋可以提高代碼可讀性和維護(hù)性改橘,不僅為了標(biāo)識(shí)此塊代碼的含義滋尉,很多時(shí)候包含了對(duì)業(yè)務(wù)邏輯的解釋,項(xiàng)目中難免有邏輯復(fù)雜之處飞主,不加注釋的代碼狮惜,數(shù)日后自己看都會(huì)覺(jué)得陌生高诺,更不要說(shuō)其他人看了,今天分享一下Objective-C開(kāi)發(fā)中常用的代碼注釋方式以及應(yīng)用場(chǎng)合碾篡。
注釋形式
注釋形式主要有:
單行注釋虱而,多行注釋,方法注釋开泽,方法集注釋(配合代碼塊實(shí)現(xiàn)快速注釋)
1. 單行注釋
使用 // 注釋單行代碼牡拇,最常見(jiàn)的使用場(chǎng)景是在方法內(nèi)注釋某個(gè)屬性或某塊區(qū)域的含義眼姐,如下圖:
2. 多行注釋
使用 /** 文本 **/ 的注釋格式(快捷鍵cmd+alt+/)可以對(duì)屬性和類以及方法進(jìn)行注釋诅迷,與//不同的是,該注釋方式可以寫多行罢杉,一般使用在類的頭文件贡歧,多行介紹當(dāng)前類的含義,如下圖:
3. 方法注釋
與方法2相同,使用 /** 文本 **/ 的注釋格式(快捷鍵cmd+alt+/)可以對(duì)方法進(jìn)行注釋而叼,快捷鍵會(huì)根據(jù)方法參數(shù)自動(dòng)生成需要填寫的注釋內(nèi)容葵陵,并且在其他地方使用該方法時(shí)瞻佛,Xcode會(huì)智能提示出之前寫的注釋內(nèi)容绊困,如下圖:
在方法上方使用快捷鍵 cmd+alt+/:
使用該方法時(shí)顯示注釋內(nèi)容:
4:方法集注釋(配合代碼塊實(shí)現(xiàn)快速注釋)
先介紹一下川梅,何為方法集注釋,通常沒(méi)有添加方法集的類是這樣的:
為了快速定位類中的某塊代碼然遏,或某個(gè)方法待侵,Xcode為我們提供了方法集的注釋方式秧倾,可大大減少搜尋目標(biāo)代碼的時(shí)間,如圖:
這樣就能對(duì)類中的方法和模塊一覽無(wú)余斤葱,要查找或修改的時(shí)候可以迅速定位衩茸,節(jié)省時(shí)間抖部,提高自我體驗(yàn)。
實(shí)現(xiàn)方法:
( #pragma mark <#注釋的內(nèi)容#> )
但是每次敲這些字符一定不是你想要的效果运杭,在Xcode8之前可以使用VVDocumenter增強(qiáng)版(個(gè)人在原基礎(chǔ)上修改添加方法集注釋功能)熊榛,由于Xcode8默認(rèn)禁用使用插件玄坦,所以我們采用代碼塊+快捷鍵的方式來(lái)實(shí)現(xiàn)煎楣,效果也是酸爽:
上圖中,就是我使用代碼塊+快捷鍵來(lái)實(shí)現(xiàn)的方法集注釋困曙,編寫方便绑榴,快捷,具體實(shí)現(xiàn)步驟如下:
添加代碼塊并設(shè)置快捷鍵:
這樣就大功告成赤套,保存代碼塊,在代碼中使用預(yù)設(shè)的快捷鍵剔氏,編譯器會(huì)自動(dòng)提示竹祷,回車谈跛,輸入即可。
記得代碼塊預(yù)設(shè)的時(shí)候“注釋內(nèi)容外要用<#>” 塑陵。