在 Doxygen 中注释文件答案

【问题标题】：Comment a file in Doxygen在 Doxygen 中注释文件
【发布时间】：2015-07-05 04:59:04
【问题描述】：

我有一个 C 标头，我想为其写一个介绍性评论。像这样：

/**
 * @brief Provides stuff for my great program.
 */

#ifndef MYHEADER_H
#define MYHEADER_H

#define __USE_GLIBC

#endif

此外，我有这个 Doxyfile：

FULL_PATH_NAMES = YES
TAB_SIZE = 8
OPTIMIZE_OUTPUT_FOR_C = YES
RECURSIVE = YES
INPUT = .
EXTRACT_ALL = YES
QUIET = YES
EXTRACT_STATIC = YES

当我现在运行 Doxygen 时，它会生成 HTML 和 LaTeX 文档，但简短的描述最终会记录宏而不是整个文件。

那么如何向 Doxygen 提供文件的简要说明？

【问题讨论】：

标签： c doxygen

【解决方案1】：

您应该使用@file 宏来表示与整个文件相关的注释：

/**
 * @file myheader.h
 * @brief Provides stuff for my great program.
 */

【讨论】：

【解决方案2】：

假设您的文件名为header.h。这样做：

/*! @file header.h
 *  @brief Provides stuff for my great program.
 *
 *  Detailed description here, if any.
 */

【讨论】：

【解决方案3】：

虽然使用@file myfile.ext 可以在任何文件中使用（即不仅仅是文档注释所在的文件），但根据the docs，只使用@file 将记录当前文件。

完整示例

/**
 * @file
 * @brief A file that is documented.
 *
 * Detailed description, etc.
 */

【讨论】：