keil5 添加注释说明模板

最新推荐文章于 2025-06-04 10:32:39 发布
原创 最新推荐文章于 2025-06-04 10:32:39 发布 · 1.6w 阅读 · 47 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#Keil5 #注释模板

本文介绍如何在Keil5中自定义注释模板，实现代码编写时的快速注释，提高开发效率。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

我们使用 Keil uvision5 编写代码时，为了规范代码，一般会在文件开头对本文件进行注释说明，同时我们也会在函数的开头对函数进行说明。但 Keil5 集成开发环境中没有这些注释模板，而手工添加过于重复繁琐，所以这里给出一种利用 Keil5 进行“半自动”添加的方法。

在 Keil 中进行如下操作：Edit --> Configuration --> Text Completion，出现如下所示界面。在这里添加自己的注释模板，完成后点击 OK 即可。


在这里插入图片描述

调用的方式如下图所示操作：


在这里插入图片描述

设置完之后会出现 Templates 栏，选择自己的注释模板，双击，效果如下：


在这里插入图片描述

keil 快速插入注释,KEIL/IAR 与 Doxygen 快速上手 - 嵌入式编程的注释管理小技巧
weixin_39899226的博客
03-16 1524
KEIL/IAR 与 Doxygen 快速上手 - 嵌入式编程的注释管理小技巧在代码量较小时，一些朴素的注释习惯也许还能应付，但随着工程量增大，养成一些好的注释习惯并应用一定的工具，会大大提高代码的整体可读性。Keil和IAR是常用的嵌入式编程IDE，Doxygen是一个功能强大的代码文档生成软件，能够根据源代码的注释自动生成对应的文档。这里简单讲讲如何快速地利用Keil或者IAR的模板功能，写出...
7步教你使用Keil使用注释模板，好好注释，从我做起！
乐天的博客
03-03 6169
前言 当你看到别人好的注释模板的时候是否还在多文件复制粘贴呢？ 教你一招 把前人好的模板套用起来 好好注释，从我做起！ 提示：本操作在Keil4环境下进行，Keil5环境同理 一、打开view菜单 二、选择Templates Window选项 三、右击Template菜单栏选择配置选项 四、点击编辑C文件选项 五、点击添加，输入注释模板名称 六、将模板内容复制到下方text文字编辑区 七、写代码时直接套用 总结 Template菜单实际上是快速模板，菜单当中还可添加常用的函数等框架式语段，这
MDK5插件函数文档注释格式化代码等
12-02
MDK5插件
解决Keil v5 中出现中文注释乱码的问题
weixin_45813121的博客
06-04 2371
解决Keil v5 中出现中文注释乱码的问题
Keil5中文注释设置
大萝卜的博客
04-26 6729
新安装的Keil5在添加注释时会发现打出的中文显示为问号，这是因为Keil5默认的字符集不是中文，我们需要在设置中修改。此时回到程序代码中添加注释就会显示为中文。
keil5 中文注释
小yu宇
08-17 8803
Keil 中文注释
Keil5 软件设置增加注释和删除注释的快捷键
2501_90564548的博客
03-12 1543
Keil5 软件设置增加注释和删除注释的快捷键
Keil5使用技巧大全：代码注释、跳转函数定义等【建议收藏】
t18438605018的博客
04-09 2693
工欲善其事，必先利其器。客观说，keil IDE相比于Visual Studio / Visual Stdio Code等IED使用起来并不是很方便。当打开一个项目时，我们希望：1.快速跳转到函数定义2.快速跳转到函数声明3.参看符号所有引用4.快速注释选中的多行代码5.为代码取消注释本文讲一下，通过为Keil配置快捷键的方式来方便地使用上述功能。
keil插件包（格式化代码 文件注释 函数注释 当前日期 当前时间）
10-29
keil插件包，导入这些插件实现（格式化代码 文件注释 函数注释 当前日期 当前时间）等功能，更加方便嵌入式开发。使用教程：https://blog.youkuaiyun.com/qq_44078824/article/details/109349611
keil插件包(格式化代码 文件注释 函数注释 当前日期 当前时间)
02-07
然而，单纯的Keil本身并不包含代码格式化、注释添加以及插入当前日期和时间的功能。为了解决这个问题，开发者可以利用第三方插件来增强其功能，比如Astyle插件。 Astyle，全称为Artistic Style，是一个开源的源代码...
keil 插件代码格式化 函数注释 文件注释
最新发布
07-07
文件注释插件则专注于为整个源文件或特定模块添加统一的注释模板。这些注释模板中通常包含了文件的基本信息，如文件名、编写者、创建和修改时间、模块功能描述等。通过插件来维护这些注释，可以保证项目文件的标准化...
Keil5如何写中文注释--Keil5注释是乱码是问号怎么解决
2201_75446108的博客
08-13 681
在keil5敲代码写注释的过程中发现敲中文之后显示问号或者乱码的情况。只需按照图示过程操作即可。
keil mdk注释插件合集格式、时间、日期注释
Lim的博客
07-09 2400
在软件开发过程中，注释起着至关重要的作用。良好的注释不仅能提高代码的可读性和维护性，还能促进团队协作和知识传递。通过清晰、简洁的注释，开发者能够更容易地理解代码的逻辑、目的和实现细节，从而减少沟通成本和错误的发生。本篇文章将深入探讨注释的最佳实践，包括如何编写高质量的注释、常见的注释类型以及注释工具的使用，以帮助开发者更好地管理和维护代码。
keil中的注释
superyan0的博客
05-16 4285
@brief : 简要注释. 指该函数的简要介绍。 @param : 参数描述. @retval : 返回值描述. @exception : 异常描述. @see : 参见. 具体用法详见 1.5.2 @see、@sa（参见） . @warning : 警告. @bug : 警告. @name : 组名. 用于给成员们分组, 既文档中Tasks区的子类别.
keil建立工程模板
李昭的博客
02-07 1328
然后，将“启动及内核文件”中的core_cm3.c、core_cm3.h 、system_stm32f10x.c、system_stm32f10x.h、stm32f10x.h文件复制到工程文件夹Template\Libraries\CMSIS中（CMSIS为新建的文件夹），如下图所示。首先，把“启动及内核文件”中的“startup_stm32f10x_hd.s”文件复制到工程文件夹“Template\Libraries\STARTUP”中（STARTUP为新建的文件夹）。工程新建完成以后需要添加组文件夹。
keil 添加自己注释模板，修改快捷键
qq_38974193的博客
05-19 2152
Edit-->Configuration-->Text Completion：2->添加自己的注释模板后，点击OK在自己的工程中就可以看到了3. 点击开头注释，就可以出现自己的模板了。<br/>修改快捷键...
MDK5插件：代码格式整理、文件注释、函数注释
沮丧的迈克尔
04-06 5049
略略略
Keil uVision5注释输入中文打问号?(四步搞定)
Ven%的博客
01-23 1216
第三步.点击Encoding的下拉框,找到UTF-8。第二步.点击Configuration。第四步 点击下方的OK,即可完成。
KEIL添加作者注释模板
William_Zhang_优快云的博客
08-31 2605
一、预览 1. 文件头注释 /*************************************************** * @brief something * @date 2021/08/31 * @author your name ****************************************************/ 2. 函数头注释 /** * @brief something * @param none * @return non
keil5注释模板
03-26
<think>好的，我现在需要帮助用户找到Keil 5中的注释模板或规范。根据用户的问题，他提到想寻找在Keil 5中使用的注释模板或规范，并希望看到示例。用户还提供了三个引用内容，其中引用[1]提到了C/C++ Editor files的文本模板，包括#define、#if、#include等，以及头文件的模板。引用[3]提到了使用Doxygen的特殊注释格式，以/**开头，并用标签生成文档。 首先，我需要确定Keil MDK是否自带注释模板。根据引用[1]，Keil的文本模板功能允许用户插入预定义的代码片段，比如头文件的模板。这可能包括文件头注释，比如版权信息、作者、日期等。用户可能需要在Text Templates设置中找到这些模板，或者手动创建。 其次，关于Doxygen的注释规范，引用[3]提到使用/**开头和特殊标签。这在Keil中需要用户自行配置，可能需要按照Doxygen的格式来编写函数和文件的注释，比如@brief、@param、@return等标签。 接下来，我需要考虑用户可能的实际需求。用户可能希望注释模板既能符合公司或项目的规范，又能利用Doxygen生成文档。因此，示例应包括文件头注释和函数注释，展示常用的标签和结构。 另外，用户可能对如何在Keil中设置这些模板不太清楚，所以需要说明如何访问Text Templates设置，比如通过Configuration -> Editor -> Text Templates，并选择C/C++文件类型。 还需要注意Keil版本和库的兼容性，如引用[2]提到的MDK_v5.35和STM32标准库版本，这可能影响某些配置，但注释模板本身是编辑器功能，应不受版本限制。 最后，生成相关问题时要围绕注释规范、Doxygen集成、自动插入方法、维护建议等方面，帮助用户进一步了解相关主题。</think>### Keil 5 注释模板规范与示例 #### 一、Keil 自带的注释模板功能 1. **文本模板入口** 在Keil MDK中，可通过菜单栏选择 `Configuration -> Editor -> Text Templates` 进入模板设置界面。此处可针对C/C++文件类型预定义代码片段（如文件头、函数注释等）[^1]。 2. **基础模板示例** - **文件头模板**： ```c /******************************************************************************* * @file 文件名 * @author 作者 * @date YYYY-MM-DD * @brief 文件功能描述 ******************************************************************************/ ``` - **函数注释模板**： ```c /** * @brief 函数功能描述 * @param 参数名: 参数说明 * @retval 返回值说明 */ ``` #### 二、Doxygen兼容注释规范[^3] Keil可通过Doxygen风格注释生成API文档，需遵循以下格式： ```c /** * @addtogroup 模块名 * @{ */ /** * @brief 初始化串口通信 * @param baudrate: 波特率（单位：bps） * @retval HAL_OK: 成功 | HAL_ERROR: 失败 */ HAL_StatusTypeDef UART_Init(uint32_t baudrate) { // 实现代码 } /** @} */ // 结束模块分组 ``` #### 三、实际工程示例 ```c /******************************************************************************* * @file main.c * @author TechTeam * @date 2023-10-01 * @brief 主程序文件，包含系统初始化和主循环 *******************************************************************************/ /** * @defgroup 应用层 * @brief 核心业务逻辑实现 */ /** * @ingroup 应用层 * @brief 系统主函数 * @param None * @retval int 程序退出状态码 */ int main(void) { HAL_Init(); // 硬件抽象层初始化[^2] while(1) { // 主循环 } } ``` #### 四、模板配置建议 1. **统一缩进**：建议使用4空格缩进 2. **标签选择**： - `@brief` 替代 `/*!<` 行尾注释 - `@attention` 标记关键注意事项 3. **版本控制集成**： 可在文件头添加： ```c * @version V1.2.0 * @note 修改日志： * - 2023-10-02 新增UART模块 ```
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值