Linux indent命令詳解 code formatter

文章目錄

• 文法
• 描述

我目前使用的格式是

indent -npro -gnu -i4 -ts4 -sob -l200 -ss -bl -bli 0 -npsl filename

 

http://publib.boulder.ibm.com/infocenter/aix/v6r1/index.jsp?topic=%2Fcom.ibm.aix.cmds%2Fdoc%2Faixcmds3%2Findent.htm

http://www.gnu.org/software/indent/manual/html_chapter/indent_1.html 

indent 命令

用途

重新格式化一個 C 語言程式。

文法

indent InputFile [ OutputFile ] [ -nbad | -bad ] [ -nbap | -bap ] [ -nbbb | -bbb ] [ -nbc | -bc ] [ -br | -bl] [ -cn] [ -cdn ] [ -ncdb | -cdb ] [ -nce | -ce] [ -cin ] [ -clin ] [ -dn ] [ -din ] [ -ndj | -dj ] [ -nei| -ei ] [ -fa ] [ -nfa ] [ -nfc1 | -fc1 ] [ -in ] [ -nip | -ip ] [ -ln ] [ -lcn ] [ -nlp | -lp ] [ -npro] [ -npcs | -pcs ] [ -nps | -ps ] [ -npsl| -psl ] [ -nsc | -sc ] [ -nsob | -sob ] [ -nslb | -slb ] [ -st ] [ -troff ] [ -nv | -v ] [ -TType ] ...

描述

indent 命令按照隨命令輸入的標誌所指定的格式重新格式化一個 C 程式。

如果只指定 InputFile 參數，重格式化的檔案寫回 InputFile 參數並且一個 InputFile 的備份副本被寫回目前的目錄，檔案名稱帶 .BAK 尾碼。

如果指定 OutputFile 參數，則 indent 命令將執行檢查以確保它的名稱與 InputFile 參數並不相同。

要為 indent 命令設定自己的預設概要檔案，在您登入目錄或目前的目錄中建立一個名為 .indent.pro 的檔案。在這個檔案中，包含想包含的標誌，這些標誌用空格、定位字元或分行符號隔開。

目前的目錄下 .indent.pro 檔案中的標誌覆蓋那些在您的登入目錄下的標誌（ 除了 -T Type 標誌，它是累積的）。如果 indent 命令運行並且一個概要檔案存在，概要檔案被讀入以設定程式的預設配置。然而，命令列上的標誌覆蓋概要檔案標誌。 

 

 

 

功能說明：調整C原始代碼檔案的格式。

語　　法：indent [參數][源檔案] 或 indent [參數][源檔案][-o 目標檔案]
補充說明：indent可辨識C的原始代碼檔案，並加以格式化，以方便程式設計師閱讀。
參　　數：
　-bad或–blank-lines-after-declarations 　在聲明區段或加上空白行。
　-bap或–blank-lines-after-procedures 　在程式或加上空白行。
　-bbb或–blank-lines-after-block-comments 　在注釋區段後加上空白行。
　-bc或–blank-lines-after-commas 　在聲明區段中，若出現逗號即換行。
　-bl或–braces-after-if-line 　if(或是else,for等等)與後面執行區段的”{“不同行，且”}”自成一行。
　-bli<縮排格數>或–brace-indent<縮排格數> 　設定{ }縮排的格數。
　-br或–braces-on-if-line 　if(或是else,for等等)與後面執行跛段的”{“不同行，且”}”自成一行。
　-bs或–blank-before-sizeof 　在sizeof之後空一格。
　-c<欄數>或–comment-indentation<欄數> 　將注釋置於程式碼右側指定的欄位。
　-cd<欄數>或–declaration-comment-column<欄數> 　將注釋置於聲明右側指定的欄位。
　-cdb或–comment-delimiters-on-blank-lines 　注釋符號自成一行。
　-ce或–cuddle-else 　將else置於”}”(if執行區段的結尾)之後。
　-ci<縮排格數>或–continuation-indentation<縮排格數> 　敘述過長而換行時，指定換行後縮排的格數。
　-cli<縮排格數>或–case-indentation-<縮排格數> 　使用case時，switch縮排的格數。
　-cp<欄數>或-else-endif-column<欄數> 　將注釋置於else與elseif敘述右側定的欄位。
　-cs或–space-after-cast 　在cast之後空一格。
　-d<縮排格數>或-line-comments-indentation<縮排格數> 　針對不是放在程式碼右側的注釋，設定其縮排格數。
　-di<欄數>或–declaration-indentation<欄數> 　將聲明區段的變數置於指定的欄位。
　-fc1或–format-first-column-comments 　針對放在每行最前端的注釋，設定其格式。
　-fca或–format-all-comments 　設定所有注釋的格式。
　-gnu或–gnu-style 　指定使用GNU的格式，此為預設值。
　-i<格數>或–indent-level<格數> 　設定縮排的格數。
　-ip<格數>或–parameter-indentation<格數> 　設定參數的縮排格數。
　-kr或–k-and-r-style 　指定使用Kernighan&Ritchie的格式。
　-lp或–continue-at-parentheses 　敘述過長而換行，且敘述中包含了括弧時，將括弧中的每行起始欄位內容垂直對其排列。
　-nbad或–no-blank-lines-after-declarations 　在聲明區段後不要加上空白行。
　-nbap或–no-blank-lines-after-procedures 　在程式後不要加上空白行。
　-nbbb或–no-blank-lines-after-block-comments 　在注釋區段後不要加上空白行。
　-nbc或–no-blank-lines-after-commas 　在聲明區段中，即使出現逗號，仍舊不要換行。
　-ncdb或–no-comment-delimiters-on-blank-lines 　注釋符號不要自成一行。
　-nce或–dont-cuddle-else 　不要將else置於”}”之後。
　-ncs或–no-space-after-casts 　不要在cast之後空一格。
　-nfc1或–dont-format-first-column-comments 　不要格式化放在每行最前端的注釋。
　-nfca或–dont-format-comments 　不要格式化任何的注釋。
　-nip或–no-parameter-indentation 　參數不要縮排。
　-nlp或–dont-line-up-parentheses 　敘述過長而換行，且敘述中包含了括弧時，不用將括弧中的每行起始欄位垂直對其排列。
　-npcs或–no-space-after-function-call-names 　在調用的函數名稱之後，不要加上空格。
　-npro或–ignore-profile 　不要讀取indent的設定檔.indent.pro。
　-npsl或–dont-break-procedure-type 　程式類型與程式名稱放在同一行。
　-nsc或–dont-star-comments 　註解左側不要加上星號(*)。
　-nsob或–leave-optional-semicolon 　不用處理多餘的空白行。
　-nss或–dont-space-special-semicolon 　若for或while區段僅有一行時，在分號前不加上空格。
　-nv或–no-verbosity 　不顯示詳細的資訊。
　-orig或–original 　使用Berkeley的格式。
　-pcs或–space-after-procedure-calls 　在調用的函數名稱與”{“之間加上空格。
　-psl或–procnames-start-lines 　程式類型置於程式名稱的前一行。
　-sc或–start-left-side-of-comments 　在每行注釋左側加上星號(*)。
　-sob或–swallow-optional-blank-lines 　刪除多餘的空白行。
　-ss或–space-special-semicolon 　若for或swile區段今有一行時，在分號前加上空格。
　-st或–standard-output 　將結果顯示在標準輸出裝置。
　-T 　資料類型名稱縮排。
　-ts<格數>或–tab-size<格數> 　設定tab的長度。
　-v或–verbose 　執行時顯示詳細的資訊。
　-version 　顯示版本資訊。

 

 

 

Indent代碼格式化說明

使用的indent參數	值	含義
--blank-lines-after-declarations	bad	變數聲明後加空行
--blank-lines-after-procedures	bap	函數結束後加空行
--blank-lines-before-block-comments	bbb	塊注釋前加空行
--break-before-boolean-operator	bbo	較長的行，在邏輯運算子前分行
--blank-lines-after-commas	nbc	變數聲明中，逗號分隔的變數不分行
--braces-after-if-line	bl	"if"和"{"分做兩行
--brace-indent 0	bli0	"{"不繼續縮排
--braces-after-struct-decl-line	bls	定義結構，"struct"和"{"分行
--comment-indentationn	c33	語句後注釋開始於行33
--declaration-comment-columnn	cd33	變數聲明後注釋開始於行33
--comment-delimiters-on-blank-lines	ncdb	不將單行注釋變為塊注釋
--cuddle-do-while	ncdw	"do --- while"的"while"和其前面的"}"另起一行
--cuddle-else	nce	"else"和其前面的"}"另起一行
--case-indentation 0	cli0	switch中的case語句所進0個空格
--else-endif-columnn	cp33	#else, #endif後面的注釋開始於行33
--space-after-cast	cs	在類型轉換後面加空格
--line-comments-indentation n	d0	單行注釋（不從1列開始的），不負值縮排
--break-function-decl-args	nbfda	關閉：函數的參數一個一行
--declaration-indentationn	di2	變數聲明，變數開始於2行，即不必對齊
--format-first-column-comments	nfc1	不格式化起於第一行的注釋
--format-all-comments	nfca	不開啟全部格式化注釋的開關
--honour-newlines	hnl	Prefer to break long lines at the position of newlines in the input.
--indent-leveln	i4	設定縮排多少字元，如果為tab的整數倍，用tab來縮排，否則用空格填充。
--parameter-indentationn	ip5	舊風格的函數定義中參數說明縮排5個空格
--line-length 75	l75	非注釋行最長75
--continue-at-parentheses	lp	續行從上一行出現的括弧開始
--space-after-procedure-calls	pcs	函數和"("之間插入一個空格
--space-after-parentheses	nprs	在"（"後"）"前不插入空格
--procnames-start-lines	psl	將函數名和傳回型別放在兩行定義
--space-after-for	saf	for後面有空格
--space-after-if	sai	if後面有空格
--space-after-while	saw	while後面有空格
--start-left-side-of-comments	nsc	不在產生的塊注釋中加*
--swallow-optional-blank-lines	nsob	不去掉可添加的空行
--space-special-semicolon	nss	一行的for或while語句，在";"前不加空。
--tab-size	ts4	一個tab為4個空格（要能整除"-in"）
--use-tabs	ut	使用tab來縮排