在评论中使用@discussion 有什么好处？答案

【问题标题】：What's the benefit of using @discussion in comments?在评论中使用@discussion 有什么好处？
【发布时间】：2012-02-28 06:38:20
【问题描述】：

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

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

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

【问题讨论】：

你能举个例子，或者添加一些更好的标签以便上下文清晰吗？
是的，编辑了原帖。
是什么语言？我不知道我熟悉的语言有什么特殊意义，但如果你用适当的语言标记这个问题，其他人也许可以回答。
做了一些研究，谢谢大家。它支持多种语言。由于是苹果公司开发的，所以很受Obj-C的欢迎；但它也兼容 C++ 和其他语言。

标签： objective-c documentation comments headerdoc

【解决方案1】：

@discussion是苹果HeaderDoc中使用的标签。

This page 包含以下描述：

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

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

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

所以它本质上是一个描述，标签名称有点误导。

【讨论】：