RTEMS 头文件注释规范
在嵌入式实时系统开发中，保持文档的一致性不仅是为了好看，更是为了后续维护的便利。RTEMS 社区对 Doxygen 注释有着明确的约定，尤其是头文件的头部声明部分。
标准结构示例
一个标准的头文件注释块通常包含功能描述、所属组别以及版权声明。下面是一个典型的 Flip-Flop API 头文件注释模板：
/**
* @file
*
* @ingroup FlipFlop
*
* @brief Flip-Flop API
*/
/*
* Copyright (c) YYYY Author.
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
关键标签说明
- @file：标识当前文件，通常留空让 Doxygen 自动推断文件名，或者手动指定。
- @ingroup：将函数归类到特定的逻辑组中，方便浏览 API 列表。
- @brief：简要描述该文件或函数的核心功能。
- Copyright：保留原有的许可证声明，这是开源合规的重要部分。
实际编写时，建议直接复制项目的标准模板，避免遗漏关键字段。这样生成的 HTML 文档结构清晰，团队成员查阅起来也更高效。
