如何构建XCode 5代码完成提示

时间:2014-01-28 13:27:58

标签: objective-c xcode5 documentation-generation code-completion code-hinting

尝试通过检查一些第3个库头来向我自己的objective-c头文件添加代码完成提示。如果Xcode5中有代码完成标准,则类似于VisualStudio。 我看到“//!description”(没有配额)工作得非常好。

//! well seems working as a code completion hint
-(void)myMethod:(BOOL)myParam1 (NSString*)myParam2;

我的问题1:如何添加换行符?

//! well seems working as a code completion hint
//! but this second line seems added into first description in code completion hint
-(void)myMethod:(BOOL)myParam1 (NSString*)myParam2;

我的问题2:寻找类似于此的标准

//! <method>myMethod:does something good.</method>
//! <param> (BOOL)myParam1:is first parameter </param>
//! <param> (NSString*)myParam2:is second parameter </param>
-(void)myMethod:(BOOL)myParam1 (NSString*)myParam2;

你可以给我一个关于“//!description”(没有配额)的文档怎么样? 看一些关于“如何编写代码在xcode中为objective-c添加描述标准”的标准

(分享任何想法和知识;谢谢。)

1 个答案:

答案 0 :(得分:1)

我使用javadoc格式,这似乎工作正常:

/**
 * Summary of method.
 *
 * A bit more detail, if you really must know stuff.
 *
 * @code
 * Some sample code.
 * @endcode
 *
 * @see http://stackoverflow.com
 *
 * @param p1 A parameter, no less.
 * @param p2 Another parameter.
 *
 * @return YES if it's Wednesday, else NO.
 */

有关详情,请参阅此article