痞子衡嵌入式：恩智浦SDK驅動代碼風格檢查工具預覽版

　　你們好，我是痞子衡，是正經搞技術的痞子。

　　接上文 《恩智浦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
  
• 支持檢查規則設置（使能/不使能，命名風格自選擇）
  
• 支持過濾文件/文件夾規則設置
  
• 支持檢查的實時進度條顯示

歡迎訂閱

文章會同時發佈到個人 博客園主頁、CSDN主頁、微信公衆號 平臺上。

微信搜索"痞子衡嵌入式"或者掃描下面二維碼，就能夠在手機上第一時間看了哦。