在Xcode中为Objective-C文档中的参数编写多行描述

它是非常 easy to do 在Swift中,但是对于Objective-C,有一个简单的hack可以使参数描述看起来像是在多行中。

只需添加另一个第一个单词是 whitespace unicode character (空间除外)。在下面的示例中,我在第2行复制了unicode U+2007。

/**
 This is the description

 @param argumentString: This is a comment,
 @param   which looks like a multiline comment
*/
- (void)doSomething:(NSString *)argumentString;

上例中的第二个@param行实际上是:

@param U+2007 <space> <comment-text>

可以复制的unicode是:  

结果

这就是它在Xcode中的呈现方式:

试试这个:

/**
* @param argumentString This is a multiline
*                       comment
*                       about
*                       argumentString
*/