且构网

分享程序员开发的那些事...
且构网 - 分享程序员编程开发的那些事

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

更新时间:2022-12-05 10:08:21

大家好消息!Xcode 5 现在内置了对 DOxygen 样式注释的支持.所以,你可以像这样评论你的方法:

Good news everyone! Xcode 5 now has built-in support for DOxygen style comments. So, you can comment your methods like this:

/*!
 * 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
 * 
eturns The a shared NSManagedObjectContext for the application.
 */
+ (NSManagedObjectContext *)sharedContext;


















这是一个方便的代码片段,您可以添加您的 Xcode 代码片段库以简化方法文档:

Here's a handy code snippet you can add the your Xcode Code Snippet library to make method documentation simple:

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

现在,您只需输入doxy"就可以了!你有你的 doxygen 模板.

Now, you can just type "doxy" and poof! You have your doxygen template.