xcode的功能文档准备

Question

我必须为objective-c类方法准备功能文档，如下例所示。

/*!
 @function       getEmployeeDetails

 @abstract       getEmployeeDetails

 @discussion     This function will fetch employee details based on employee id

 @param          strEmpId 

 employee unique id

 @result         an Array of Employee

 */

-(void)getEmployeeDetails :(nsstring *)strEmpId{
}

我在下面的链接中提到了HeaderDoc User Guide，并了解了如何手动准备

功能文件是否有快捷键？

Answer 1

您可以使用VVDocumenter：

  

撰写文档对于开发来说非常重要，但确实如此   Xcode很痛苦。想想你浪费了多少时间   按＆＃39; *＆＃39;或＆＃39; /＆＃39;，然后反复输入参数。现在，   您可以找到要记录的方法（或任何代码），以及   键入///，将为您和所有参数生成文档   return将被提取为兼容的Javadoc样式   与appledoc，Doxygen和HeaderDoc。你可以填写内联   占位符令牌可以完成您的文档。

使用Xcode运行项目后，在任何项目中，您都可以通过输入＆＃34; ///＆＃34;来生成文档。 （您可以在设置中更改此字符串）：