在開(kāi)發(fā)過(guò)程中,有的是因協(xié)同開(kāi)發(fā),有的是不同人用的代碼編輯器可能是不一樣,有的是應(yīng)為個(gè)人風(fēng)格原因,有的是代碼中Tab跟空格混用,有時(shí)候用Tab,有時(shí)候又用空格。再整個(gè)項(xiàng)目的代碼整合再一起的時(shí)候。導(dǎo)致代碼格式都沒(méi)有對(duì)齊,if,while等嵌套多了,括號(hào)也沒(méi)對(duì)齊,導(dǎo)致代碼可讀性不高,也不夠規(guī)范,自己看的也不整潔,在我們攻城獅領(lǐng)域,先不說(shuō)內(nèi)涵,寫的代碼有多么精妙,最基本的代碼的可讀性,整潔度就是我們的門面,是吧,所以這方面應(yīng)該保持基本的“強(qiáng)迫癥”。
針對(duì)常用編輯器 IAR KEIL 這類編輯器沒(méi)有相對(duì)應(yīng)的工具,介紹一款小插件Artistic Style,最新版本是3.1。
插件介紹
Artistic Style適用于C,C ++,C ++ / CLI,Objective C,C#和Java源代碼,是一款免費(fèi),快速,小型自動(dòng)格式化程序。由Jim Pattee維護(hù)和更新,原始作者是以色列的塔爾·戴維森(Tal Davidson)。
KEIL 設(shè)置方法:
1.首先從官網(wǎng)下載軟件,為了方便就把軟件下載后的解壓包放在在C:SofewareKeil_v5AStyle這個(gè)目錄,大家可以根據(jù)自己的喜好來(lái)放在其他目錄;
2.打開(kāi)MDK,在菜單欄Tools中選擇 Customize Tools Menu,然后按照下圖一步步做;
3.最后一步格式配置這里,是有很多不同格式命令的:
- -n:不生成備份文件。
- !E:格式化當(dāng)前文件。
- –indent=spaces=2 :縮進(jìn)使用空格,空格個(gè)數(shù)為2(你可以修改數(shù)字為其他的)。
- –align-pointer=name :*,&,^靠近變量名稱。
- –pad-oper:運(yùn)算符兩端插入空格。
- –pad-comma :逗號(hào)后插入空格,如果啟用了上面的選項(xiàng),此參數(shù)也可以省略。
- –unpad-paren :取消括號(hào)內(nèi)部或者外部的空格(比如函數(shù)名靠近括號(hào))。
- –attach-return-type-decl :返回值類型與函數(shù)名稱保持在同一行。
- –convert-tabs :將TAB轉(zhuǎn)換為空格。
- –attach-closing-while :do while循環(huán)的while語(yǔ)句跟第二個(gè)大括號(hào)保持在同一行。
- –indent-switches :switch語(yǔ)句中的case選項(xiàng),要保持縮進(jìn)格式。
- –max-instatement-indent=60 :一行代碼的字符長(zhǎng)度,如果超過(guò)這個(gè)長(zhǎng)度會(huì)斷開(kāi)并換行。
- --style=ansi :大括號(hào)對(duì)齊方式,ansi 可以替換為 Linux, GNU,,java。
- --align-pointer=name/-k3 指針?lè)?hào)緊貼名字。
4.這里整理了一個(gè)我常用的命令,格式化當(dāng)前文件:!E --style=ansi -n -p -s4 -S -f -xW -w -xw。
5.使用前:
6.使用后:
IAR 設(shè)置方法:
1.首先從上面官網(wǎng)下載軟件,為了方便就把軟件下載后的解壓包放在在C:SofewareIAR SystemsEmbedded
Workbench 8.30.1AStyle這個(gè)目錄,大家可以根據(jù)自己的喜好來(lái)放在其他目錄;
2.打開(kāi)IAR,在菜單欄Tools中選擇configure tools,然后按照下圖一步步做;
3.最后一步格式配置這里,與上面配置大致一樣,其中 !E命令無(wú)法在 IAR 中使用,使用的環(huán)境變量 $FILE_PATH$。
4.在IAR也整理了一個(gè)常用的命令,對(duì)當(dāng)前文件生效:-n -p -D -s4 -F -S -H --style=ansi $FILE_PATH$。
5.使用前:
6.使用后:
- 快捷鍵設(shè)置:
設(shè)置好以上命令后,每次都需要先點(diǎn)擊 Tools 再點(diǎn)擊設(shè)置的命令。顯得過(guò)于繁瑣。這時(shí)候需給剛剛設(shè)置的命令添加一個(gè)快捷鍵。便于快速操作:
KEIL: 按照以下操作:
IAR按照以下操作:
- 注意事項(xiàng):
在使用此插件時(shí),需要保存文件。
使用此插件后,ctrl+z 撤回不可再用,如要查看格式化之前的文件,請(qǐng)刪除命令中的 “-n” 不生成備份文件,即默認(rèn)的 .orig文件,這樣,每次使用此插件都會(huì)生成一個(gè)對(duì)應(yīng)的.orig文件。里邊保存的四格式化之前的文件。