C 在Doxygen中注释文件

我有一个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提供该文件的简要描述呢？

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

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

---

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

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

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

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

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

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

虽然使用@file myfile.ext可以在任何文件中工作，例如，根据，不仅仅是文档注释所在的文件，只使用@file将记录当前文件

完整示例

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

虽然使用@file myfile.ext可以在任何文件中工作，例如，根据，不仅仅是文档注释所在的文件，只使用@file将记录当前文件

完整示例

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

---

最后我做了一个小小的改动：我在@file后面省略了文件名，因为我不喜欢冗余。尽管如此，我最终还是做了一个小小的改动：我在@file后面省略了文件名，因为我不喜欢冗余。尽管如此，它仍然有效。