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

我正在尝试这样做：

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

但是我不认为

@param

支持多行描述同一个参数。我还没有找到一个方法来做到这一点；我的最终目标是使所有的文本都出现在同一节的正确部分。使用上述代码，有关argumentString的

注释

部分将移到描述部分。我尝试过使用，但似乎不起作用。

试试这个：

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

试试这个：

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

这在Swift中非常有用，但对于Objective-C，有一个简单的方法可以使参数描述看起来像是在多行中

只需添加另一个参数，其第一个单词是a（而不是空格）。在下面的示例中，我在第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>

@param U+2007

可以复制的unicode是：

 

结果

这是它在Xcode中的呈现方式：


这在Swift中非常常见，但对于Objective-C，有一个简单的方法可以使参数描述看起来像是在多行中

只需添加另一个参数，其第一个单词是a（而不是空格）。在下面的示例中，我在第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>

@param U+2007

可以复制的unicode是：
 

结果

这是它在Xcode中的呈现方式：


谢谢你的回答！这是可行的，它符合赏金描述，但我忘了添加快速帮助中生成的描述也应该有相应的换行符，换行符出现在注释中。有没有办法达到这个目的？据我所知，没有，没有谢谢你的回答！这是可行的，它符合赏金描述，但我忘了添加快速帮助中生成的描述也应该有相应的换行符，换行符出现在注释中。有没有办法实现这一目标？据我所知，没有