MDK5插件代码格式整理文件注释函数注释

2020-08-28

MDK5插件:代码格式整理、文件注释、函数注释

简介

本仓库提供了一个用于MDK5(Keil MDK)的插件资源文件,该插件主要用于代码格式整理、文件注释和函数注释。通过安装这些插件,开发者可以更高效地管理代码格式和注释,提升代码的可读性和维护性。

插件功能

  1. 代码格式整理:自动对代码进行格式化,确保代码风格一致,提升代码的可读性。
  2. 文件注释:在C和H文件中自动生成文件注释,方便开发者快速了解文件内容和用途。
  3. 函数注释:在函数定义前自动生成注释模板,帮助开发者记录函数的功能、参数和返回值等信息。

安装步骤

  1. 下载插件:从本仓库下载插件压缩包。
  2. 导入插件:将插件中的tools文件夹复制到MDK5的安装目录中。
  3. 配置插件:打开MDK5,添加外部插件,选择对应的执行文件并填写正确的Arguments。

使用说明

  • 代码格式整理:在代码编辑器中选择需要格式化的代码,使用插件进行格式化。
  • 文件注释:在C和H文件的顶部使用插件生成文件注释。
  • 函数注释:在函数定义前使用插件生成函数注释模板。

注意事项

  • 插件的Arguments需要正确填写,否则可能无法正常工作。
  • 插件的注释模板可以根据个人需求进行修改。

参考资料

贡献

欢迎开发者提交改进建议和Bug报告,帮助我们完善插件功能。

许可证

本项目遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。

下载链接

MDK5插件代码格式整理文件注释函数注释