keil mdk注释插件合集格式、时间、日期注释

news2024/9/23 17:17:59

文章目录

一、前言
二、安装步骤
- 2.1 解压tools.zip
- 2.2 tools 文件解释
- 2.3 添加注释带keil
三、配置
- 3.1 格式化代码
- 3.2 文件注释
- 3.3函数注释
- 3.4 当前日期
- 3.5 当前时间
四、编辑注释模板
- 4.1 编辑函数注释模板
- 4.2 编辑C文件注释模板
- 4.3 编辑h文件注释模板
五、为注释功能添加快捷键
六、工具文件下载地址

一、前言

在软件开发过程中，注释起着至关重要的作用。良好的注释不仅能提高代码的可读性和维护性，还能促进团队协作和知识传递。通过清晰、简洁的注释，开发者能够更容易地理解代码的逻辑、目的和实现细节，从而减少沟通成本和错误的发生。

本篇文章将深入探讨注释的最佳实践，包括如何编写高质量的注释、常见的注释类型以及注释工具的使用，以帮助开发者更好地管理和维护代码。

二、安装步骤

2.1 解压tools.zip

把文件放在 Keil 的安装目录下，目录下面右 ARM文件夹

在这里插入图片描述

2.2 tools 文件解释

在这里插入图片描述

2.3 添加注释带keil

打开 Keil tools → Customize Tools Menu… → Export

选择刚刚解压出来的 插件脚本.cfg，添加完入下图

在这里插入图片描述

三、配置

安装完成，检查一下是否正确

3.1 格式化代码

Arguments 填入命令 $E*.c" "$E*.h

Command 选择Astyle.exe 文件地址

在这里插入图片描述

3.2 文件注释

Arguments 填入命令 !E

Command 选择FileComments.exe 文件地址

在这里插入图片描述

3.3函数注释

Arguments 填入命令 !E ~E

Command 选择FunctionComment.exe 文件地址

在这里插入图片描述

3.4 当前日期

Arguments 填入命令 !E ~E ^E

Command 选择DateTime.exe 文件地址

在这里插入图片描述

3.5 当前时间

Arguments 填入命令 !E ~E ^E T

Command 选择DateTime.exe 文件地址

在这里插入图片描述

四、编辑注释模板

4.1 编辑函数注释模板

打开 funtction.c 文件

/****************************** BEFIN ********************************
**
**@Name       : {FunctionName}
**@Brief      : None
**@Param {Parameters} 
**@Return     : None
**@Author     : @mayuxin
**@Data	      : {Date}
******************************** END *********************************/

{FunctionName}： 函数名

{Parameters}： 参数，可能会有多个参数

{Date}： 当前日期

4.2 编辑C文件注释模板

打开 File.c 文件

/************************************* Copyright(C)******************************
**
**                 (C) Copyright {Year}, @mayuxin,China, GCU.
**                            All Rights Reserved
**                     				By( @myx)
**-------------------------------------------------------------------------------
** @FileName   : {FileName}
** @Brief	     :
**
**-------------------------------------------------------------------------------
** @Author     : @mayuxin
** @Version    : v1.0
** @Date       : {Date}
**-------------------------------------------------------------------------------
** @Mender	   : Node
** @Version    : Node
** @Date       : Node
** @Brief      : Node
********************************************************************************/

{FileName}： 文件名字

{Date}： 当前日期

4.3 编辑h文件注释模板

打开 File.h 文件

/************************************* Copyright(C)******************************
**
**                 (C) Copyright {Year}, @mayuxin,China, GCU.
**                            All Rights Reserved
**                     				By( @myx)
**-------------------------------------------------------------------------------
** @FileName   : {FileName}
** @Brief	     :
**
**-------------------------------------------------------------------------------
** @Author     : @mayuxin
** @Version    : v1.0
** @Date       : {Date}
**-------------------------------------------------------------------------------
** @Mender	   : Node
** @Version    : Node
** @Date       : Node
** @Brief      : Node
********************************************************************************/

{FileName}： 文件名字

{Date}： 当前日期

没有看错 c文件 和 h文件的注释是一样的，这个是个人爱好。