我正在尝试使用 Doxygen 记录 PHP 类成员(我没有使用 PHPDocs,因为该项目涉及 COCOA 编程,所以我可以对这两个部分使用相同的工具)。
/**
* This is brief description.
*
* This is detailed description.
*/
private $foo;
Run Code Online (Sandbox Code Playgroud)
这段代码正确完成了文档,但我想在文档中包含 var 应该处理的类型。
我尝试使用 \var 和 \property,但是 Doxigen 没有为 var 生成文档。
//THIS IS NOT WORKING!
/**
* This is brief description.
*
* This is detailed description.
* \var int
*/
private $foo;
Run Code Online (Sandbox Code Playgroud)
我看过这篇文章: Doxygen:如何在 php 中描述类成员变量?
似乎 \var 在 Doxyegn 中不起作用,但该帖子有点旧,也许我现在可以做些什么。
我已经关注了这个功能的错误评论:
https://bugzilla.gnome.org/show_bug.cgi?id=626105。
在第 6 条评论中提出了一个解决方案,在类型后添加 var 名称。
class Mine {
/**
* Definition of variable
* @var string $var
*/
private $var = array();
}
Run Code Online (Sandbox Code Playgroud)
这对我有用。
| 归档时间: |
|
| 查看次数: |
1795 次 |
| 最近记录: |