在Xcode中创建“快速帮助”条目

Question

如何在Xcode中为自己的代码创建快速帮助条目？ 我只是想把它作为编码支持，就像编写Java时的Eclipse功能一样。 在eclipse中，当你将方法悬停在其他地方时，你会得到一个在方法上面输入的注释。

Xcode等效似乎是“快速帮助”。

除了使用Doxygen之外真的没别的办法吗？ 对于我正在研究的小项目来说，Doxygen似乎有些过分。 目前我确实知道我只想彻底填写快速帮助，所以请避免任何提示，例如“你必须为你的项目创建文档”。

我真的很感激任何帮助，因为我在这个主题上唯一能找到的就是question。

但正如您所见，没有可用的解决方案。

Answer 1

是的......你可以..这是一个现成的“Snippet”，你可以拖动或自动完成等等......

/** 
 * <#summary#>
 * @param <#name#> <#how you gonna get it?#>
 * @param <#name#> <#really, there's more?#>
 * @return <#name#> <#what do you want!#>
 */

将“拖到”片段“东西”上，就像你知道的那样..设置它......

并且有它...

Answer 2

我认为唯一的方法是为您的代码创建文档集，然后将其安装在XCode上：

  

Xcode 4的上下文帮助，Apple   称为“快速帮助”，完全依赖于   已安装的文档集。   Xcode 4自动下载   文档集（包括更新）   对于Mac OS和iOS API，但你   也可以安装第三方集。

     

（...）

     

创建你的   文档集，您可以安装它   在Xcode的偏好中（在   文档选项卡）。假设文件   set正确构建和安装，   快速帮助应该“正常工作”   当然这是有限的使用，除非   你正在与一个共享复杂的API   群体或广阔的世界。

来源：http://xcodebook.com/2011/04/providing-your-own-quick-help/

Apple的文档集指南： http://developer.apple.com/library/mac/documentation/DeveloperTools/Conceptual/Documentation_Sets/

Answer 3

从Xcode 5.0开始，变量和方法的Doxygen和HeaderDoc格式在“快速帮助”弹出窗口中自动解析和呈现。有关它的更多信息here，但这里有一些关键部分：

/**
 * Add a data point to the data source.
 * (Removes the oldest data point if the data source contains kMaxDataPoints objects.)
 *
 * @param aDataPoint An instance of ABCDataPoint.
 * @return The oldest data point, if any.
 */
 - (ABCDataPoint *)addDataToDataSource:(ABCDataPoint *)aDataPoint;

在Xcode中呈现为：

至于物业，它就像：

一样简单

/// Base64-encoded data.
@property (nonatomic, strong) NSData *data;

当点击选项时，会出现这个可爱的弹出窗口：

Answer 4

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 5

对于有兴趣如何在Swift 3中执行此操作的人。

/**
 Makes a route

 - Parameters:
      - Parameter1 : The *x* component.
      - Parameter2 : The *y* component.
 - Throws: Error.IncorrectX if the x parameter 
    is less than zero.

 - Returns: A new integer answer which is x*y.

*/

参数1和2必须是您给出参数的正确名称。

Answer 6

您可以轻松地使用 AppleDoc 创建DocSet，并生成QuickHelp-Links（选项⌥+鼠标单击）。

示例和终端命令的二进制文件在这里：

http://gentlebytes.com/appledoc-docs-examples-basic/

我尝试了它，只使用了基本开关，新的DocSet与QuickHelp配合使用：

./appledoc --project-name testdocs --project-company "My Company" --company-id com.mycompany --output ~/Desktop ~/Desktop/appledoc-master

Answer 7

刘易斯Swift 3答案的稍作修改和代码片段版本：

    /**
 <#summary#>

 <#discussion#>
 Example:
 ````
 <#example codeblock#>
 ````
 - important: <#important stuff here#>

 - version: <#version number#>

 - Parameter <#param1#> : <#description#>
 - Parameter <#param2#> : <#description#>

 - Throws: <#error description#>

 - Returns: <#return value#>

 */

我不得不使用单独的参数语法，因为Xcode否则会破坏代码段中嵌套参数的格式（无论出于何种原因）。