我们使用 Keil uvision5 编写代码时,为了规范代码,一般会在文件开头对本文件进行注释说明,同时我们也会在函数的开头对函数进行说明。但 Keil5 集成开发环境中没有这些注释模板,而手工添加过于重复繁琐,所以这里给出一种利用 Keil5 进行“半自动”添加的方法。
在 Keil 中进行如下操作:Edit --> Configuration --> Text Completion,出现如下所示界面。在这里添加自己的注释模板,完成后点击 OK 即可。
添加方法如下:
调用的方式如下图所示操作:
设置完之后会出现 Templates 栏,选择自己的注释模板,双击,效果如下:
常用注释:
@author 作者
@brief 摘要
@version 版本号
@date 日期
@file 文件名,可以默认为空,DoxyGen会自己加
@class 类名
@param 函数参数
@return 函数返回值描述
@exception 函数抛异常描述
@warning 函数使用中需要注意的地方
@remarks 备注
@see see also字段
@note brief下空一行后的内容表示详细描述,但也可以不空行用note表示
@par 开始一个段落,段落名称描述由你自己指定,比如可以写一段示例代码
@code 引用代码段
@endcode 引用代码段结束
@pre 函数前置条件,比如对输入参数的要求
@post 函数后置条件,比如对系统状态的影响或返回参数的结果预期