【问题标题】:How to disable slash command syntax in Doxygen如何在 Doxygen 中禁用斜杠命令语法
【发布时间】:2012-03-12 06:15:26
【问题描述】:

我遇到了 PHP 5.3 命名空间和 Doxygen cmets 的问题。

例子:

/**
 * Sample Method
 *
 * @param string $output
 * @return \Project\Lib\Rest
 */

Doxygen 给我以下警告:

warning: Found unknown command `\Project'
warning: Found unknown command `\Lib'
warning: Found unknown command `\Rest'

我可以做些什么来解决这个问题或关闭 \commands 并且只使用 @commands

【问题讨论】:

    标签: php php-5.3 doxygen


    【解决方案1】:

    尝试转义反斜杠,即使用

    /**
     * Sample Method
     *
     * @param string $output
     * @return \\Project\\Lib\\Rest
     */
    

    \\ 实际上是一个 doxygen 命令,它只打印一个反斜杠。

    另见Documenting PHP with Doxygen: The Pros and Cons

    /**
     * Sample Method
     *
     * @param string $output
     * @return Project::Lib::Rest
     */
    

    【讨论】:

    • 这不是很好,因为这样双斜杠对于正在阅读文档源(例如头文件)的用户来说是可见的,这可能会使他们感到困惑。
    猜你喜欢
    • 2014-03-21
    • 2023-02-26
    • 1970-01-01
    • 2021-09-18
    • 1970-01-01
    • 2021-06-22
    • 2021-11-09
    • 2021-07-17
    • 1970-01-01
    相关资源
    最近更新 更多