其他分享
首页 > 其他分享> > 痞子衡嵌入式:恩智浦SDK驱动代码风格检查工具预览版

痞子衡嵌入式:恩智浦SDK驱动代码风格检查工具预览版

作者:互联网

过去的三天里我花了一些时间做了一个基于 PyQt5 的 GUI 工具,可以帮助检查你的代码风格是否符合恩智浦 SDK 驱动开发规范,如今这个工具的第一个预览版(v0.4)出来了

大家好,我是痞子衡,是正经搞技术的痞子。

  接上文 《恩智浦SDK驱动代码风格、模板、检查工具》 继续聊,是的,过去的三天里我花了一些时间做了一个基于 PyQt5 的 GUI 工具,可以帮助检查你的代码风格是否符合恩智浦 SDK 驱动开发规范,如今这个工具的第一个预览版(v0.4)出来了,欢迎大家试用(当然更欢迎加入这个开源项目一起来开发)。
  我知道你不是恩智浦 SDK 驱动的开发者,但恩智浦毕竟是一线 MCU 大厂,作为一个嵌入式从业者(尤其是你还没有找到一个明确的代码风格),如果写的代码能符合恩智浦规范,何尝不是一件快事!

1.代码风格

  • 风格细则:https://github.com/JayHeng/MCUX-SDK-Coding-Style/blob/master/coding_style.md

2.代码模板

  • 头文件模板:https://github.com/JayHeng/MCUX-SDK-Coding-Style/blob/master/template.h
  • 源文件模板:https://github.com/JayHeng/MCUX-SDK-Coding-Style/blob/master/template.c

3.检查工具

  MCUXpresso SDK Coding Style Checker 是恩智浦 SDK 驱动 C 代码风格配套检查工具,其功能类似于 JAVA 代码下的 CheckStyle 工具(默认绑定 Google 风格以及 Sun 规范),也类似于 Linux 下的 scripts/checkpatch.pl 脚本,只不过提供的规范检查没有这两个工具丰富,是一个轻量级的 GUI 工具,更适合普通 MCU 开发者使用。

  • 工具:\MCUX-SDK-Coding-Style\checker\bin\MCUX-SDK-CodingStyleChecker.exe

  MCUXpresso SDK Coding Style Checker 主要功能如下:

  • 支持选择单文件或整个文件夹去检查
  • 自动识别 .c/.h 后缀文件,但要保证文件是 UTF-8 或 ASCII 编码(即不能包含非英文字符)
  • 能够显示检查结果的统计信息(总代码行,错误行,通过率)
  • 支持检查结果Log的保存
  • 支持检查五种通用注释头(Definitions/Variables/Prototypes/Code/API)
  • 支持检查全局变量的命名规范(在Variables注释头下)
  • 支持检查宏定义的命名规范(在Definitions注释头下)
  • 支持检查枚举定义的命名规范(在Definitions注释头下)
  • 支持检查结构体定义的命名规范(在Definitions注释头下)
  • 支持检查函数的命名规范(在Code注释头下)
  • 支持检查头文件保护宏

  To-Do List:

  • 支持 coding_style.md里的 rule 2.x
  • 支持检查规则设置(使能/不使能,命名风格自选择)
  • 支持过滤文件/文件夹规则设置
  • 支持检查的实时进度条显示


标签:恩智浦,检查,代码,预览版,Coding,工具,SDK
来源: https://blog.51cto.com/u_12094353/2713935