KEIL/IAR 与 Doxygen 快速上手 - 嵌入式编程的注释管理小技巧
在代码量较小时,一些朴素的注释习惯也许还能应付,但随着工程量增大,养成一些好的注释习惯并应用一定的工具,会大大提高代码的整体可读性。Keil和IAR是常用的嵌入式编程IDE,Doxygen是一个功能强大的代码文档生成软件,能够根据源代码的注释自动生成对应的文档。这里简单讲讲如何快速地利用Keil或者IAR的模板功能,写出有规范代码注释的代码,同时也简单介绍Doxygen如何在Keil和IAR工程原文件的基础上建立文档的主要步骤。
1.使用Keil的模板(Template)功能
Keil的提供一个模板功能,也就是一些常用的结构,如循环体和函数等,可以自动生成一个框架,然后具体的内容可以额外填写,十分方便。
使用模板
要使用模板功能,十分容易,在Keil中编辑状态下,如果Keil的视图和布局没有改变1,右边应该是工程文件的浏览界面。这个界面的右下角,可以点选模板(Template,图中第四个)栏:
就可以看到很多常用的C语言的一些程序结构,点击任意一个&#x