12、嵌入式软件开发：Doxygen文档与硬件抽象层设计指南

嵌入式软件开发：Doxygen文档与硬件抽象层设计指南

1. Doxygen主页面设置

Doxygen通过识别文件顶部的 @mainpage 标签来将文件识别为主页面。添加该标签后，开发者需使用HTML标签来创建页面布局和信息流。以下是一些相关要点：
- HTML命令 ：开发者无需成为HTML专家，有几个HTML命令很有用，可用于创建链接等。例如，使用HTML锚点标签创建表格链接，点击链接时页面会跳转到锚点，便于导航主页面文档。
- 页面分区 ：主页面目录部分的每个条目可视为一个独立部分。Doxygen有内置的 section 命令用于分隔内容，还有 subsection 命令用于进一步细分信息，帮助开发者组织主页面和控制信息流向。
- 插入图片 ：Doxygen有插入图片的标签，格式为 image 加上类型（如 html 、 rtf 、 latex ）和文件名（如 image.jpg ）。若要创建多种类型的文档，需添加多个图片标签。

2. C代码注释的十个技巧

2.1 解释“为什么”而非“怎么做”

开发软件时，人们倾向于解释代码在做什么，而非为什么这么做。例如：

// Shift bit by 8 an