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

Question

我正在尝试这样做：

/**
 @param argumentString This is a multiline
 comment
 about
 argumentString
 */
- (void)doSomething:(NSString *)argumentString;

但是我不认为@param支持描述同一参数的多行。我还没有找到一种方法来做到这一点。我的最终目标是使所有文本显示在正确部分的同一部分中。使用上述代码，comment about argumentString部分将被移至“描述”部分。我尝试使用@parblock，但似乎不起作用。

Answer 1

尝试一下：

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

Answer 2

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

只需添加另一个参数，其第一个单词是whitespace unicode character（空格除外）。在以下示例中，我在第二行中复制了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中的呈现方式：