objective-c – 如何在Xcode的自动填充弹出窗口中包含Doxygen方

发布时间：2020-12-15 02:01:28 所属栏目：百科来源：网络整理

导读：使用Xcode，我想把自己的方法下面的方法描述为自动完成选项，如alloc：写入时，Xcode将显示自动填充文档中的注释。您可以在图像中看到，例如，从选项中选择alloc时，它会显示“返回接收类的新实例”，并链接到文档。例如，我已经能够使用Doxygen记录我的源

使用Xcode，我想把自己的方法下面的方法描述为自动完成选项，如alloc：

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

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

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

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

解决方法

大家好消息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#>
 */

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

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!