Objective-C 注释文档/** @discussion @param @see @return .... */

Question

我在/** */中看到越来越多的带有注释的这种@marker，我正在寻找一些文档，解释它们是什么以及如何使用它。谢谢!

/**
 @param blabla...
 @return bla...
 @see ...
 @method ...
 @discussion ...
 */

Answer 1

这是内联(好吧，在注释中)文档，一种 self 记录代码的特殊方法。这种特殊的样式称为 Javadoc样式，除了 Javadoc 工具外，许多流行的文档生成器都支持它，包括 Doxygen和 Appledoc .

编写某些代码(应用程序、库等)文档的目的是开发人员不需要维护代码库和文档的单独文件结构；这些自动实用程序可以根据评论中嵌入的信息生成格式良好(例如 HTML)的文档。

另请注意，这并不是严格意义上的语言相关功能。不要被 @ (at) 符号混淆，这不是 Objective-C 特定的语法(相反，它特定于所使用的特定文档生成器程序)。