objective-c - 在评论中使用@discussion 有什么好处？

Question

我在一些示例代码中看到了@discussion。我的问题是，使用这个关键字有什么好处？

我想它会生成更好的文档。我尝试在 Google 和 Stackoverflow 上搜索，但得到了很多代码示例，而不是如何使用这个关键字。谢谢。

// Example
/*!
    @method     blabla method name
    @discussion blabla discuss here
    @param      blabla describe the parameters
    @result     blabla results
 */

Answer 1

@discussion是 Apple 的HeaderDoc中使用的标签。

此页面包括以下说明：

详细描述函数、类、标题或数据类型的文本块。这可能包含多个段落。@discussion 可以省略，如上所述。

如果您有数据类型、函数、类或标题的多字名称，则必须存在 @discussion。

@discussion 块仅在另一个块开始时结束，例如 @param 标记。

所以它本质上是一个带有轻微误导标签名称的描述。