20

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

图像

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

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

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

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

4

3 回答 3

52

大家好消息！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 代码片段库以简化方法文档：

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

doxygen 代码片段

现在，你可以输入“doxy”然后噗！你有你的 doxygen 模板。

于 2013-10-15T15:01:18.930 回答
3

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

于 2014-01-25T20:43:06.860 回答
2

我能够使用 Appledocs 实现我想要的，尽管我在安装和设置方面做了一些努力......

  1. 打开 xCode 并转到 xCode> Preferences > Downloads 并下载“命令行工具”以防万一。

  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. 选择文档，转到构建阶段选项卡，然后单击下方的“添加构建阶段”并选择添加运行脚本。

  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. 最后，转到产品 > 方案 > 编辑方案 > 构建选项卡并添加您的“文档”目标，确保选中每个框。这样，每次构建代码时，您的文档都会更新。

就是这样，您可以开始记录您的代码了。请注意，尽管每次构建时文档都会更新，但弹出框建议在您重新启动 Xcode 之前不会更新。有关正确的文档技术，请阅读本文

于 2013-08-18T05:12:57.860 回答