我有一个 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 提供文件的简短描述呢？
最佳答案
您应该使用@file 宏来表示与整个文件相关的注释:
/**
* @file myheader.h
* @brief Provides stuff for my great program.
*/
关于在 Doxygen 中评论一个文件，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/29883909/