我使用Doxygen为我的客观c代码生成文档。到目前为止，我还没有找到任何关于如何正确记录属性的指导。我看过的例子都是可以想到的。有些人自己记录变量，有些人记录@property声明。有些使用//，而其他使用全/ ** * /块。Objective C @property comments
任何人都可以指出我的最佳实践参考？或者也许有关于Doxygen未来兼容性的一些信息？我想坚持一种模式，一旦他们发展出正式模式，至少可以很容易地适应Doxygen。
我能说的是，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：
的@财产被要求作为doxygen的 找不到属性名 否则。
像只读存取器属性， 复制/保留/分配和非原子被自动添加 并在 文档的手动部分不应 发生。
在这里您可以找到有关编码约定的Objective-C的一些信息：Google Objective-C Style Guide
但是如果你想，有一个其他良好的软称为HeaderDoc下生成的XCode文档。你可以在这里查看它的编码风格：HeaderDoc Tags
我的经验是：
当我使用注释里面的@property标签，属性doxygen的输出被损坏，如：[类名]：读，写，分配。
如果我ommit @property标签，而是依靠doxygen在源代码中找到'@property'声明，正好在注释块下面，一切正常。
相比之下，@interface适用于接口，而@protocol适用于协议。
另外，在过去，我在某些协议声明上做了doxygen'slip'。 Obj-C仍然是二等公民？
注：我使用的GUI /向导在Mac上，并注释块使用 '！/ * *'而不是'/ * *'。
有用的参考资料，我投了票，但没有真正回答我的任何问题。谷歌文档省略@property评论的任何指导方针，headerdoc当然是替代品，但不是我的解决方案。 – DougW 2010-03-05 21:37:04