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

注釋規(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)容外要用<#>” 塑陵。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末感憾,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子令花,更是在濱河造成了極大的恐慌阻桅,老刑警劉巖凉倚,帶你破解...
    沈念sama閱讀 216,591評(píng)論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異嫂沉,居然都是意外死亡占遥,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,448評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門输瓜,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人芬萍,你說(shuō)我怎么就攤上這事尤揣。” “怎么了柬祠?”我有些...
    開(kāi)封第一講書人閱讀 162,823評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵北戏,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我漫蛔,道長(zhǎng)嗜愈,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書人閱讀 58,204評(píng)論 1 292
  • 正文 為了忘掉前任莽龟,我火速辦了婚禮蠕嫁,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘毯盈。我一直安慰自己剃毒,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,228評(píng)論 6 388
  • 文/花漫 我一把揭開(kāi)白布搂赋。 她就那樣靜靜地躺著赘阀,像睡著了一般。 火紅的嫁衣襯著肌膚如雪脑奠。 梳的紋絲不亂的頭發(fā)上基公,一...
    開(kāi)封第一講書人閱讀 51,190評(píng)論 1 299
  • 那天,我揣著相機(jī)與錄音宋欺,去河邊找鬼轰豆。 笑死,一個(gè)胖子當(dāng)著我的面吹牛齿诞,可吹牛的內(nèi)容都是我干的秒咨。 我是一名探鬼主播,決...
    沈念sama閱讀 40,078評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼掌挚,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼雨席!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起吠式,我...
    開(kāi)封第一講書人閱讀 38,923評(píng)論 0 274
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤陡厘,失蹤者是張志新(化名)和其女友劉穎抽米,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體糙置,經(jīng)...
    沈念sama閱讀 45,334評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡云茸,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,550評(píng)論 2 333
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了谤饭。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片标捺。...
    茶點(diǎn)故事閱讀 39,727評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖揉抵,靈堂內(nèi)的尸體忽然破棺而出亡容,到底是詐尸還是另有隱情,我是刑警寧澤冤今,帶...
    沈念sama閱讀 35,428評(píng)論 5 343
  • 正文 年R本政府宣布闺兢,位于F島的核電站,受9級(jí)特大地震影響戏罢,放射性物質(zhì)發(fā)生泄漏屋谭。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,022評(píng)論 3 326
  • 文/蒙蒙 一龟糕、第九天 我趴在偏房一處隱蔽的房頂上張望桐磁。 院中可真熱鬧,春花似錦讲岁、人聲如沸所意。這莊子的主人今日做“春日...
    開(kāi)封第一講書人閱讀 31,672評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)扶踊。三九已至,卻和暖如春郎任,著一層夾襖步出監(jiān)牢的瞬間秧耗,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書人閱讀 32,826評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工舶治, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留分井,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,734評(píng)論 2 368
  • 正文 我出身青樓霉猛,卻偏偏與公主長(zhǎng)得像尺锚,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子惜浅,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,619評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容