在评论中使用@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包含以下说明：

  

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

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

     

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

所以它本质上是一个 description ，标签名称略有误导。