iOS注釋的正確寫法

假如自己寫了一個(gè)iOS庫,如何做到像系統(tǒng)庫那樣,在Xcode的Quick help里有注釋說明呢?如下圖那樣

1.其實(shí)很簡單,只要按照固定格式在頭文件里寫注釋就可以了,其格式也是編程通用注釋格式。

如上圖格式,寫好描述,參數(shù)@param,返回值@return。就可以在Xcode的Quick help里顯示出來了。

另外:

2.你可能覺得這么寫注釋很麻煩,其實(shí)有插件支持這種注釋寫法的,只要連按三個(gè)"/",插件就會(huì)自動(dòng)把注釋框架寫好,自己填內(nèi)容就可以了。常用的注釋插件如VVDocumenter。

3.Xcode8官方不太支持插件了,但是提供了快捷鍵 :Command + Option +/ 更方便了。?

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • github排名https://github.com/trending,github搜索:https://gith...
    小米君的demo閱讀 4,958評(píng)論 2 38
  • 讀《正確看待第一》一文有感 魏宇博 今天,我讀完了名叫《正確看待第...
    小奔先生閱讀 382評(píng)論 0 3
  • 今天是一個(gè)重大的日子,傳說中的三八婦女節(jié)。對(duì)于母親來說,也是她唯一一個(gè)正兒八經(jīng)的過的節(jié)日,母親也打算好好享受一下節(jié)...
    我家有個(gè)小太陽2014閱讀 228評(píng)論 0 0
  • 淋雨 我沒有過歡樂 何來傷悲 我感受不到兩個(gè)人彼此 相愛相殺 我不對(duì)你說我的心事 我以為我不必說 獨(dú)自穿過幽暗的歲...
    雪吻水晶島閱讀 265評(píng)論 0 1

友情鏈接更多精彩內(nèi)容