php - 如何记录 Doxygen 中不存在的变量？

Question

例如，我在配置文件中定义了 $theme 全局变量，它没有被 Doxygen 处理。但我想记录下来。我试着这样做:

/**
 * @var $theme
 * @brief Active theme.
 */

但是没用。

Answer 1

您可以创建一个 doxygen 特定文件来记录变量，例如:

配置.dox

/**
 * @defgroup configuration Configuration
 */

/**
 * @ingroup configuration
 * @brief Active Theme
 */
$theme;

这将创建一个名为“Configuration”的新 Doxygen 模块，它将包含变量 $theme。您还可以将 $theme 与特定类相关联(使用 @memberof 而不是 @ingroup)。