我正在尝试用Doxygen记录PHP类成员(我没有使用PHPDocs,因为该项目涉及COCOA编程,因此我可以对两个部分使用相同的工具)。
/**
* This is brief description.
*
* This is detailed description.
*/
private $foo;
此代码可以正确完成文档,但我希望在文档中包含var应该处理的类型。
我尝试使用\ var和\ property,但Doxigen不会为var生成doc。
//THIS IS NOT WORKING!
/**
* This is brief description.
*
* This is detailed description.
* \var int
*/
private $foo;
我看过这篇文章: Doxygen: how to describe class member variables in php?
似乎\ var在Doxyegn中不起作用,但帖子有点旧,也许我现在可以做些什么。
答案 0 :(得分:3)
我已按照此功能的错误评论:
https://bugzilla.gnome.org/show_bug.cgi?id=626105
在评论编号6中,提出了一种解决方案,在类型之后添加var名称。
class Mine {
/**
* Definition of variable
* @var string $var
*/
private $var = array();
}
这对我有用。
答案 1 :(得分:0)
生成可接受结果的简单解决方法是添加此输入过滤器:
INPUT_FILTER = "sed -e 's/@var\s/@see /'"
甚至更好地定义别名:
ALIASES += "var=@see"
它只是用@var
命令替换@see
命令。它并不完美,但它非常简单且相对防弹。
小缺点是类型在描述中的某处而不是标题。另一方面,如果只有少数属性定义了类型,则会使文档更加一致(标题看起来相同)。
答案 2 :(得分:0)
@type
为我工作:
/** @type string[] */
private $csvData;
/**
* command line parameters
* @type string[]
*/
private $parameters;