iphone - Objective C @property 注释

Question

我使用 Doxygen 为我的 Objective-C 代码生成文档。不过到目前为止，我还没有找到任何关于如何正确记录属性的指南。我看过的示例以各种可能的方式进行。有些人自己记录变量，有些人记录@property 声明。一些使用//，而另一些使用完整的/** */ block 。

任何人都可以为我指出最佳实践引用吗？或者也许是关于 future 与 Doxygen 兼容性的一些信息？我想坚持一种模式，至少，一旦他们开发出官方模式，就很容易适应 Doxygen。

Answer 1

我只能说 Core Plot framework使用类似

的格式在实现中注释属性声明

 /** @property myProperty
 *   @brief Property is very useful
 *   Useful and there is a lot more to tell about this property **/

它似乎使用 Doxygen 生成干净的文档。来自Core Plot documentation policy :

The @property is required as doxygen cannot find the property name otherwise.

Accessor properties like readonly, copy/retain/assign, and nonatomic are automatically added and should not occur in the manual part of the documentation.