doxygen忽略封装在语句中的类

Doxygen不会用它的静态分析来解释代码,因此if子句只是代码,而类定义没有用于文档(这也是有意义的,因为它只是有条件的,很可能不需要)。

将类定义外部化,这样静态代码分析就不会有问题。这样,也可以很容易地要求此类定义。它还与自动加载兼容(本答案中未记录),Doxygen对此没有任何问题。

...

if (!class_exists('Myfile', false))
{
    require(__DIR__ . '/Myfile.php');
}

...

我的文件.php

<?php
class Myfile
{
    ...
}

由于我不会说PHP,我将提供一个可能的与Doxygen相关的答案:

尝试用 \cond 对doxygen隐藏代码的命令。

/** \cond */
if(!class_exists('FooBar', false)) {
/** \endcond */

    /**
     * Docs
     **/
    class FooBar
    {

    }

/** \cond */
}
/** \endcond */

我不确定这是否可行-这取决于Doxygen的解析顺序-但在您开始打开修改Doxygen将带来的复杂性之前,似乎值得一试。

您也可以使用此筛选器(复制自 GitHub ):

<?php

// Get the input
$source = file_get_contents($argv[1]);
// removes the whole line
list($head,$tail) = preg_split('/.*if\(!class_exists\(.+/', $source, 2);
$openingBracePos = strpos($tail,'{');
$closingBracePos = strrpos($tail,'}');
if($openingBracePos !== false && $closingBracePos !== false)
    $source = $head . substr($tail,$openingBracePos+1,
                             $closingBracePos-$openingBracePos-1);
// Output
echo $source;

此筛选器将删除 if(!class_exists(...)) 语句,所以doxygen理解代码,而不改变代码本身。

删除 false .会奏效的