由于XCode 5现在支持直接从头文件读取标题注释,因此以一致的方式记录功能变得越来越有趣。
因此,我尝试找到一个可以在Objective C头文件中自动插入标题文档注释的工具,但似乎无法找到它?
基本上我想要一个可以写出类似的内容:
/*!
<desc method.>
@param parmA
<desc of parmA>
@param parmB
<desc of parmB>
@result
<desc of result>
*/
- (CO2 *)doSomething:(typeName)parmA withSomething:(typeName)parmB;
答案 0 :(得分:9)
我发现这个非常方便的Xcode插件可以为你编写所有默认的注释代码。
https://github.com/onevcat/VVDocumenter-Xcode
修改强>
从Xcode 8开始,有一个新的快捷方式,与VVDocumenter插件具有相同的行为。
将光标放在任何函数,类,结构......上方,然后点击⌘ + ⌥ + /
这将根据您放置光标的位置生成注释。