代碼排版工具Uncrustify使用說明(V1.0)

《代碼排版工具Uncrustify使用說明(V1.0)》由會(huì)員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在行業(yè)資料-天天文庫(kù)。

1、FH/XXSJ/X.XXX.XXX（XXXXXX）/RA（開發(fā)管理平臺(tái)專項(xiàng)）代碼排版工具Uncrustify使用說明設(shè)備型號(hào)：產(chǎn)品代號(hào)：項(xiàng)目代號(hào)：部門：烽火通信科技股份有限公司寬帶產(chǎn)品部擬制：王瑋2011年10月27日審核：年月日批準(zhǔn)：年月日代碼排版工具Uncrustify使用說明FH/XXSJ/X.XXX.XXX（XXXXXX）/RA目錄1.版本記錄22.引言32.1.背景說明32.2.適用范圍32.3.執(zhí)行標(biāo)準(zhǔn)32.4.相關(guān)文檔32.5.參考資料33.代碼排版工具使用說明43.1.Uncrustify簡(jiǎn)介43.2.安裝Uncrustify43.3.配置Sour

2、ceInsight43.4.配置MicrosoftVisualStudio53.5.Uncrustify配置文件說明63.6.軟件編程規(guī)范排版要求的支持情況74.附錄Uncrustify參數(shù)說明9第53頁代碼排版工具Uncrustify使用說明FH/XXSJ/X.XXX.XXX（XXXXXX）/RA1.版本記錄序號(hào)文件編號(hào)生成時(shí)間主要修改記錄作者備注12011-10-27初次生成王瑋初始化文檔第53頁代碼排版工具Uncrustify使用說明FH/XXSJ/X.XXX.XXX（XXXXXX）/RA1.引言1.1.背景說明委托部門：寬帶產(chǎn)品部項(xiàng)目名稱：代碼排版工具選型

3、項(xiàng)目說明：本項(xiàng)目為更好的落實(shí)寬帶產(chǎn)品部《軟件編程規(guī)范》中關(guān)于代碼排版的要求，提高代碼的可讀性、排版的規(guī)范性，本著減少編程人員對(duì)代碼排版的工作量、提高工作效率的原則，特以Uncrustify為基礎(chǔ)開發(fā)了一款代碼排版工具。該工具作為SourceInsight以及MicrosoftVisualStudio編輯器的插件，對(duì)C語言編寫的代碼進(jìn)行排版。該工具排版之后的代碼基本可滿足部門《軟件編程規(guī)范CHECKLIST》中所有排版類的要求。1.2.適用范圍軟件使用對(duì)象：寬帶產(chǎn)品部軟件開發(fā)人員使用范圍：寬帶產(chǎn)品部產(chǎn)品軟件研發(fā)過程1.3.執(zhí)行標(biāo)準(zhǔn)序號(hào)標(biāo)準(zhǔn)名稱版本號(hào)發(fā)布單位備注01M

4、2009015-軟件編程規(guī)范1.2寬帶產(chǎn)品部1.4.相關(guān)文檔序號(hào)文檔名稱版本號(hào)作者備注01M2009015-軟件編程規(guī)范1.2向忠清1.5.參考資料序號(hào)文檔名稱版本號(hào)作者發(fā)表日期出版單位/來源備注01無第53頁代碼排版工具Uncrustify使用說明FH/XXSJ/X.XXX.XXX（XXXXXX）/RA1.代碼排版工具使用說明1.1.Uncrustify簡(jiǎn)介Uncrustify是一個(gè)代碼美化工具可用于C,C++,C#,ObjectiveC,D,Java,Pawn和VALA源代碼的美化。它能夠利用空格，tab與空格或只有tab進(jìn)行縮排,添加或刪除換行,排列代碼等，

5、并且Uncrustify具有高配置性，易于修改的特點(diǎn)，可配合SourceInsight及MicrosoftVisualStudio進(jìn)行使用。1.2.安裝Uncrustify將Uncrustify.rar文件解壓縮即可，解壓縮路徑以“c:uncrustify”為例。1.3.配置SourceInsight1打開SourceInsight,選擇菜單“Options-->CustomCommands-->Add”,輸入uncrustify2Run中輸入:C:uncrustifyuncrustify.exe-cC:uncrustifyuncrustify.cfg–

6、f%f–o%f如果不想對(duì)源代碼文件進(jìn)行備份，可以輸入：C:uncrustifyuncrustify.exe-cC:uncrustifyuncrustify.cfg--no-backup–f%f–o%f3Dir不填寫，將“File,thenLine”打上勾；4然后點(diǎn)對(duì)話框中右側(cè)的按鈕“Keys...”設(shè)置快捷鍵“Ctrl+F8”；5打開要格式化的文件，“Ctrl+F8”即可對(duì)當(dāng)前文件格式化；注1：C:uncrustifyuncrustify.exe-cC:uncrustifyuncrustify.cfg–f%f–o%f命令中，-c表明需要調(diào)用配置文件

7、，%f在SourceInsight中代表當(dāng)前文件，–o表示將排版后的輸出直接替換當(dāng)前文件（需要當(dāng)前文件已經(jīng)保存，否則SourceInsight不會(huì)提示文件被外部編輯器改變，并重新載入）。注2：%f–o%f也可以使用%s來替換，表明輸入的是當(dāng)前文件中所選擇的部分，即uncrustify只對(duì)當(dāng)前所選擇的代碼進(jìn)行排版。如果要使用這種方式，請(qǐng)將“PasteOutput”進(jìn)行勾選。第53頁代碼排版工具Uncrustify使用說明FH/XXSJ/X.XXX.XXX（XXXXXX）/RA1.1.配置MicrosoftVisualStudio1打開MicrosoftVisualS

8、tudio