如何告诉 doxygen 使用 /** 作为类文档而不是 /*！ \班级
我正在尝试从 phpDocumentor 切换到 doxygen，但我的所有类都以以下样式记录：
/**
* DESCRIPTION
*
* @category PHP
* @package UserManagement.Class
* @author Name <[email protected]>
* @copyright 2011 Company
* @link http://www.company.com
*/
但 doxygen 不会将其识别为类文档，除非我将第一行更改为
/*! \class CLASSNAME
Is有一种方法告诉 doxygen 使用“ /**“ 风格？
问候
I'm trying to switch from phpDocumentor to doxygen, but all my classes are documented in the following style:
/**
* DESCRIPTION
*
* @category PHP
* @package UserManagement.Class
* @author Name <[email protected]>
* @copyright 2011 Company
* @link http://www.company.com
*/
but doxygen does not recognize that as the class doc unless I change the first line to
/*! \class CLASSNAME
Is there a way to tell doxygen to use the "/**" style?
regards
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（3）
我发现了问题（但不是真正的解决方案）：Doxygen 不喜欢 @category & @package 在类文档块中。如果我删除它们，它就会起作用。
I found the problem (but not the real solution): Doxygen does not like the @category & @package in the class doc block. If I remove them it works.
Doxygen 应该识别 JavaDoc（即 /**）注释。问题可能是您的简短描述没有被自动检测到。
要使 Doxygen 使用这些简短描述，您需要将 JAVADOC_AUTOBRIEF 设置为
YES在你的配置文件中。有关 Doxygen 文档风格的更多信息，请查看这里
Doxygen should recognise JavaDoc (i.e. /**) comments. The problem maybe that your short description aren't being auto-detected.
To make Doxygen use these short descriptions you need to set JAVADOC_AUTOBRIEF to
YESin your config file.For more on how Doxygen documentation style have a look at this
例如，如果您的同事仍然使用 phpDoc，您可以使用
INPUT_FILTER配置来过滤掉不需要的标签：inputfilter 脚本必须是可执行的，其内容可以是这样的：
If for example your co-workers still use phpDoc you can use the
INPUT_FILTERconfiguration to filter unwanted tags away:The inputfilter script must be executable and its content can be something like this: