标签: objective-c
我已经在/ ** * /中看到越来越多这种带有注释的@marker,我正在寻找一些文档,解释它们是什么以及如何使用它。谢谢!
/** @param blabla... @return bla... @see ... @method ... @discussion ... */
答案 0 :(得分:8)
这是内联(好的,评论中)文档,一种自我记录代码的特殊方法。这种特殊的样式称为Javadoc样式,除了Javadoc工具外,许多流行的文档生成器都支持它,包括Doxygen和Appledoc。
编写某些代码(应用程序,库等)的文档的目的是开发人员不需要为代码库和维护文档的单独文件结构;这些自动实用程序可以根据注释中嵌入的信息生成格式良好的(例如HTML)文档。
另请注意,这不是严格依赖于语言的功能。不要被@(at)符号混淆,这不是Objective-C特定语法(相反,它特定于所使用的特定文档生成器程序)。