2013-09-25 32 views
2

由於XCode 5現在支持直接從頭文件讀取標題註釋,因此以一致的方式記錄功能變得越來越有趣。在Objective C中自動插入標題文檔註釋?

因此,我試圖找到一個工具,可以自動插入目標C頭文件中的頭文檔註釋,但似乎無法找到一個?

基本上,我想了一個可能會寫類似:

/*! 
    <desc method.> 
    @param parmA 
     <desc of parmA> 
    @param parmB 
     <desc of parmB> 
    @result 
     <desc of result> 
*/ 
- (CO2 *)doSomething:(typeName)parmA withSomething:(typeName)parmB; 

回答

9

我發現這非常方便的Xcode插件編寫所有默認註釋代碼爲您服務。

https://github.com/onevcat/VVDocumenter-Xcode

編輯

由於Xcode中8的,有可用的新的快捷方式具有相同的行爲VVDocumenter插件。

將光標上方的任何功能,類,結構,...和命中⌘ + ⌥ + /

這將相應到放置光標產生的註釋。

+0

看起來像完美的解決方案!然而,我無法讓它工作。它似乎只是插入我在剪貼板中的任何內容,而不是插入評論。你有沒有設法使它工作? – EsbenB

+1

是的,您應該下載主分支,構建VVDocumenter-Xcode目標並在此之後重新啓動Xcode。這對我有效。 –

+0

啊我發現我正在使用的另一個工具(剪切/粘貼文件)導致了問題。看起來像一個很好的工具!感謝名單 – EsbenB