iOS注釋規(guī)范&&提高注釋效率
iOS注釋主要分為以下幾種:屬性注釋动雹、方法集注釋捧弃、方法注釋、普通注釋(單行注釋)止喷。
1.屬性注釋
該類注釋主要用于屬性,變量名的注釋混聊。提高效率方法見下面代碼塊的使用弹谁。
2.方法集注釋
方法集注釋就是對多個(gè)方法進(jìn)行統(tǒng)一注釋,統(tǒng)一解釋幾個(gè)方法大體類型句喜,特別對一些代碼比較長的代碼文件预愤,在點(diǎn)擊代碼編寫界面上方的代碼路徑后段查看代碼里面所有的方法時(shí)候,可以有效的看出哪些方法進(jìn)行的什么操作咳胃,從而可以快速定位方法植康。
方法集注釋如下所示
方法集注釋效率的提高見下面代碼塊的使用。
3.方法注釋
方法注釋推薦采用VVDocument插件進(jìn)行注釋展懈,最新的xcode-8里面的系統(tǒng)文件里就有該插件的文件销睁,足以可見這款插件是相當(dāng)不錯(cuò)的。
方法注釋主要對單個(gè)方法進(jìn)行注釋存崖,使用VVDocument插件注釋方法很簡單冻记,連續(xù)點(diǎn)擊三次”///”就會出現(xiàn)注釋。并且它會自動識別方法名中的變量来惧,然后打印出來冗栗。注釋最上面是對方法功能的介紹,變量名的文字是對變量名的解釋。
4.普通注釋
所謂普通注釋就是代碼片段里有一句需要解釋下隅居,和絕大多數(shù)語言一樣钠至。雙斜杠進(jìn)行注釋√ピ矗或者采用統(tǒng)一樣式
5.代碼塊在注釋中的使用
Xcode自帶的代碼塊是一個(gè)非常好用的工具棉钧,可以快速的通過快捷鍵打出你想要的代碼,代碼塊主要如圖下所示乒融。加入代碼塊的方法請百度掰盘,這里不介紹了。
下面介紹下我寫的幾個(gè)注釋的代碼塊,其中title是定義的代碼塊名稱赞季,shortcut是快捷鍵愧捕。在代碼中打出快捷鍵就回彈出相應(yīng)的代碼塊供你選擇,極大的提高代碼編寫效率申钩。
1)方法集注釋
2)屬性注釋
3)普通注釋