如何使用 Doxygen 记录类属性？

Question

我正在尝试使用 Doxygen 记录类属性。目前，受保护的属性显示在特定类的页面顶部的列表中。我想给他们一个解释。

我尝试在类的开头上方和属性声明的正上方使用 @param [name] [description] 。我什至尝试将它们放入我的构造函数类的文档块中，但它只是破坏了它。

有什么我想念的吗？

——洛根

Answer 1

您必须在属性之前使用 < 或注释：

class cMainData
{
    private $attr;  //!< This is my attribute

    //! This is another attribute
    private $otherAttr;
}

请注意，您可以使用 @brief、@note 和类似的例如：

class cMainData
{
    private $attr;  //!<@brief This is my attribute.
                    //!< This is some additional info about this attribute.
}

Answer 2

我发布了一个解决方法作为此问题重复项的答案： Doxygen：如何在 php 中描述类成员变量？ 对于需要与 phpDoc 注释样式兼容的解决方案的其他人来说，从这里链接它可能会很有用。