如何在Xcode的自动完成弹出窗口中包含Doxygen方法描述？

Question

使用Xcode，我希望在自动填充选项下方使用我方法的Doxygen描述，例如alloc：

编写时，Xcode会显示自动完成以及文档中的注释。例如，您可以在图像中看到，从选项中选择alloc时，它会显示“返回接收类的新实例”，并且还链接到文档。

我已经能够用Doxygen记录我的源代码，例如

/** 
 This does nothing
*/
 -(void) doNothing
{
    // This does nothing
}

我在Doxygen生成的HTML文件中得到了预期的结果，但我不知道如何将这些结果显示为Xcode中的建议。

Answer 1

大家好消息！ Xcode 5现在内置了对DOxygen风格注释的支持。所以，你可以这样评论你的方法：

/*!
 * Provides an NSManagedObjectContext singleton appropriate for use on the main 
 * thread. If the context doesn't already exist it is created and bound to the 
 * persistent store coordinator for the application, otherwise the existing 
 * singleton contextis returned.
 * \param someParameter You can even add parameters
 * \returns The a shared NSManagedObjectContext for the application.
 */
+ (NSManagedObjectContext *)sharedContext;

内联帮助将如下所示：

快速帮助将如下所示：

侧栏帮助将如下所示：

这是一个方便的代码段，您可以添加Xcode Code Snippet库以简化方法文档：

/**
 <#description#>
 @param <#parameter#>
 @returns <#retval#>
 @exception <#throws#>
 */

现在，你可以输入“doxy”和poof！你有你的doxygen模板。

Answer 2

我发现比Doxygen / Javadoc样式评论的代码片段更好的是使用VVDocumenter-Xcode Plugin这太好了！安装完成后，您只需在要评论的任何代码上方键入“///”，它将获取参数并返回并添加占位符以便您完成注释块。

Answer 3

我能够用Appledocs实现我想要的东西，虽然我在安装和设置方面做了一些努力......

1. 打开xCode并转到xCode＆gt;偏好＆gt;下载并下载“命令行工具”，以防您没有。

2. 打开终端并输入

   git clone git://github.com/tomaz/appledoc.git
   

3. 完成后，转到appledoc文件夹，输入

   cd appledoc
   

   使用以下命令将appledoc安装到usr / local / bin文件夹中：

   sudo sh install-appledoc.sh 
   

4. 打开任何xCode项目并转到左侧的包浏览器，然后单击您的主项目文件（具有目标数量和下面详述的sdk版本的文件）

5. 在构建设置标签中，查看下方的“+添加目标”按钮并将其打开

6. 选择“聚合”模板（确保根据项目选择iOS或macosx并将其命名为“文档”

7. 选择文档，转到Build Phases选项卡，然后单击'Add Build Phase'并选择Add Run Script。

8. 将以下代码复制并粘贴到“运行脚本”字段：

   #appledoc Xcode script
   # Start constants
   company="ACME";
   companyID="com.ACME";
   companyURL="http://ACME.com";
   #target="iphoneos";
   target="macosx";
   outputPath="~/help";
   # End constants
   /usr/local/bin/appledoc \
   --project-name "${PROJECT_NAME}" \
   --project-company "${company}" \
   --company-id "${companyID}" \
   --docset-atom-filename "${company}.atom" \
   --docset-feed-url "${companyURL}/${company}/%DOCSETATOMFILENAME" \
   --docset-package-url "${companyURL}/${company}/%DOCSETPACKAGEFILENAME" \
   --docset-fallback-url "${companyURL}/${company}" \
   --output "${outputPath}" \
   --publish-docset \
   --docset-platform-family "${target}" \
   --logformat xcode \
   --keep-intermediate-files \
   --no-repeat-first-par \
   --no-warn-invalid-crossref \
   --exit-threshold 2 \
   "${PROJECT_DIR}"
   

9. 在开始常量中，您可以替换名称等，同时确保使用正确的目标（iOS或macosx）

10. 最后，转到产品＆gt;方案＆gt;编辑方案＆gt;构建选项卡并添加“文档”目标，确保选中每个框。这样，每次构建代码时，文档都会更新。

就是这样，你很高兴开始记录你的代码。 请注意，虽然每次构建时文档都会更新，但在重新启动Xcode之前，弹出窗口建议不会更新。 有关正确的文档技术，请阅读this article