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 中使用的标签。 .

This page包括以下描述:

A block of text that describes a function, class, header, or data type in detail. This may contain multiple paragraphs. @discussion may be omitted, as described above.

@discussion must be present if you have a multiword name for a data type, function, class, or header.

An @discussion block ends only when another block begins, such as an @param tag.

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