Objective c 什么';在评论中使用@discussion有什么好处?
我在一些示例代码中看到@discussion。我的问题是,使用这个关键词有什么好处 我想它会生成更好的文档。我试着在Google和Stackoverflow上搜索,但是得到了很多代码示例,而不是如何使用这个关键字。谢谢Objective c 什么';在评论中使用@discussion有什么好处?,objective-c,documentation,comments,headerdoc,Objective C,Documentation,Comments,Headerdoc,我在一些示例代码中看到@discussion。我的问题是,使用这个关键词有什么好处 我想它会生成更好的文档。我试着在Google和Stackoverflow上搜索,但是得到了很多代码示例,而不是如何使用这个关键字。谢谢 // Example /*! @method blabla method name @discussion blabla discuss here @param blabla describe the parameters @re
// Example
/*!
@method blabla method name
@discussion blabla discuss here
@param blabla describe the parameters
@result blabla results
*/
@discussion
是一个标签,用于苹果的
包括以下说明:
详细描述函数、类、标题或数据类型的文本块。这可能包含多个段落@如上所述,可以省略讨论
@如果您有数据类型、函数、类或标题的多字名称,则必须进行讨论
@discussion块仅在另一个块开始时结束,例如@param标记
因此,它本质上是一个带有轻微误导性标签名称的描述。你能举个例子,或者添加一些更好的标签,以便上下文清晰吗?是的,当然,编辑了原始帖子。它是什么语言?我不知道在我熟悉的语言中有什么特别的意义,但是如果你用合适的语言来标记这个问题,其他人可能会回答。做了一些研究,谢谢大家。它由多种语言支持。因为它是由苹果公司开发的,所以在Obj-C中非常流行;但它也与C++和其他语言兼容。