objective-c – 如何在Xcode的自动填充d出窗口中包含Doxygen方法描述?

objective-c – 如何在Xcode的自动填充d出窗口中包含Doxygen方法描述?,第1张

概述使用Xcode,我想把自己的方法下面的方法描述为自动完成选项,如alloc: 写入时,Xcode将显示自动填充文档中的注释。您可以在图像中看到,例如,从选项中选择alloc时,它会显示“返回接收类的新实例”,并链接到文档。 例如,我已经能够使用Doxygen记录我的源代码 /** This does nothing*/ -(void) doNothing{ // This doe 使用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模板。

总结

以上是内存溢出为你收集整理的objective-c – 如何在Xcode的自动填充d出窗口中包含Doxygen方法描述?全部内容,希望文章能够帮你解决objective-c – 如何在Xcode的自动填充d出窗口中包含Doxygen方法描述?所遇到的程序开发问题。

如果觉得内存溢出网站内容还不错,欢迎将内存溢出网站推荐给程序员好友。

欢迎分享,转载请注明来源:内存溢出

原文地址:https://www.54852.com/web/1073187.html

(0)
打赏 微信扫一扫微信扫一扫 支付宝扫一扫支付宝扫一扫
上一篇 2022-05-26
下一篇2022-05-26

发表评论

登录后才能评论

评论列表(0条)

    保存