[转] 代码格式化工具 uncrustify 配置文件选项详解

本文转发自whatday

Uncrustify是一个代码美化工具可用于C,C++,C#,D和Java源代码的美化。它能够利用空格，tab与空格或只有tab进行缩排,添加或删除换行,排列代码等。Uncrustify具有高配置性，易于修改的特点。持mac win linux平台，可单独使用，也可被第三方工具(如Source insight，Atom)调用。

通用(general)

缩进(Indent)

空格(Spacing)

对齐(align)

新行添加与移除

位置

行划分

空行

代码修改(非空格)

注释修改

预处理

实例

使用方法

通用(general)

换行风格

# The type of line endings

newlines = auto # auto/lf/crlf/cr

输入文件的tab 大小

# The original size of tabs in the input

input_tab_size = 8 # number

输出尺寸的tab大小

# The size of tabs in the output (only used if align_with_tabs=true)

output_tab_size = 8 # number

# The ASCII value of the string escape char, usually 92 (\) or 94 (^). (Pawn)

string_escape_char = 92 # number

运行将'>=' 和 '>>='当作模板的一部分

# Allow interpreting '>=' and '>>=' as part of a template in 'void f(list<list<B>>=val);'.

# If true (default), 'assert(x<0 && y>=3)' will be broken.

# Improvements to template detection may make this option obsolete.

tok_split_gte = false # false/true

控制如何处理UTF-8 BOM

# Control what to do with the UTF-8 BOM (recommend 'remove')

utf8_bom = ignore # ignore/add/remove/force

若文件包含值为128到255的非UTF-8字节，则输出为UTF-8

# If the file contains bytes with values between 128 and 255, but is not UTF-8, then output as UTF-8

utf8_byte = false # false/true

强制输出编码为UTF-8

# Force the output encoding to UTF-8

utf8_force = false # false/true

缩进(Indent)

每个级别缩进的列数

# The number of columns to indent per level.

# Usually 2, 3, 4, or 8.

indent_columns = 8 # number

连续(continuation)缩进,如果非0，则会覆盖'(' 和 '='的连续缩进。

# The continuation indent. If non-zero, this overrides the indent of '(' and '=' continuation indents.

# For FreeBSD, this is set to 4. Negative value is absolute and not increased for each ( level

indent_continue = 0 # number

缩进时如何使用tab

# How to use tabs when indenting code

# 0=spaces only

# 1=indent with tabs to brace level, align with spaces

# 2=indent and align with tabs, using spaces when not on a tabstop

indent_with_tabs = 1 # number

不在花括号级别的注释，用tab缩进到制表符tabstop

# Comments that are not a brace level are indented with tabs on a tabstop.

# Requires indent_with_tabs=2. If false, will use spaces.

indent_cmt_with_tabs = false # false/true

是否缩进被'\'划断的string，这样他们就可以line up。这个选项我至今没搞懂啥意思

# Whether to indent strings broken by '\' so that they line up

indent_align_string = false # false/true

用以将'{'远离级别(level)的空格数

# Spaces to indent '{' from level

indent_brace = 0 # number

花括号是否与语句体缩进到一起

# Whether braces are indented to the body level

indent_braces = false # false/true

单独的开关，函数、class、struct、'namespace'、

是否禁用缩进函数、class、struct、'namespace'的花括号

# Disabled indenting function braces if indent_braces is true

indent_braces_no_func = false # false/true

# Disabled indenting class braces if indent_braces is true

indent_braces_no_class = false # false/true

# Disabled indenting struct braces if indent_braces is true

indent_braces_no_struct = false # false/true

基于花括号的上层来缩进。例如，上层为'if'，则缩进3个空格，上层为'for'，则缩进4个空格

# Indent based on the size of the brace parent, i.e. 'if' => 3 spaces, 'for' => 4 spaces, etc.

indent_brace_parent = false # false/true

'namespace'是否缩进

# Whether the 'namespace' body is indented

indent_namespace = false # false/true

缩进空格数

# The number of spaces to indent a namespace block

indent_namespace_level = 0 # number

大于此行数的'namespace'不被缩进

# If the body of the namespace is longer than this number, it won't be indented.

# Requires indent_namespace=true. Default=0 (no limit)

indent_namespace_limit = 0 # number

'extern "C"、'class'体是否缩进

# Whether the 'extern "C"' body is indented

indent_extern = false # false/true

# Whether the 'class' body is indented

indent_class = false # false/true

是否缩进以类、冒号打头的内容

# Whether to indent the stuff after a leading class colon

indent_class_colon = false # false/true

成员初始化虚拟缩进，远离':'

# Virtual indent from the ':' for member initializers. Default is 2

indent_ctor_init_leading = 2 # number

构造函数初始化列表，额外缩进

# Additional indenting for constructor initializer list

indent_ctor_init = 0 # number

将'else \n if' 当作 'else if'来缩进

# False=treat 'else\nif' as 'else if' for indenting purposes

# True=indent the 'if' one level

indent_else_if = false # false/true

开花括号后的变量声明的缩进数量

# Amount to indent variable declarations after a open brace. neg=relative, pos=absolute

indent_var_def_blk = 0 # number

缩进连续变量声明而非对齐

# Indent continued variable declarations instead of aligning.

indent_var_def_cont = false # false/true

true，强制将函数定义从列1开始缩进

false，使用默认行为

# True: force indentation of function definition to start in column 1

# False: use the default behavior

indent_func_def_force_col1 = false # false/true

以1个缩进级别缩进连续的函数调用参数

# True: indent continued function call parameters one indent level

# False: align parameters under the open paren

indent_func_call_param = false # false/true

与上相同，不过是用于函数定义、函数原型，类声明

下面各种相同，不再赘述

# Same as indent_func_call_param, but for function defs

indent_func_def_param = false # false/true

# Same as indent_func_call_param, but for function protos

indent_func_proto_param = false # false/true

# Same as indent_func_call_param, but for class declarations

indent_func_class_param = false # false/true

# Same as indent_func_call_param, but for class variable constructors

indent_func_ctor_var_param = false # false/true

# Same as indent_func_call_param, but for templates

indent_template_param = false # false/true

# Double the indent for indent_func_xxx_param options

indent_func_param_double = false # false/true

# Indentation column for standalone 'const' function decl/proto qualifier

indent_func_const = 0 # number

# Indentation column for standalone 'throw' function decl/proto qualifier

indent_func_throw = 0 # number

缩进连续的'->' 或 '.'的空格数

# The number of spaces to indent a continued '->' or '.'

# Usually set to 0, 1, or indent_columns.

indent_member = 0 # number

用以缩进代码前的单行注释('//')的空格数

# Spaces to indent single line ('//') comments on lines before code

indent_sing_line_comments = 0 # number

若为true，将会相对地缩进行尾单行注释('//')，而非尝试保持相同绝对列

# If set, will indent trailing single line ('//') comments relative

# to the code instead of trying to keep the same absolute column

indent_relative_single_line_comments = false # false/true

用以将'case' 从 'switch'缩进开来的空格数，通常为0或indent_columns

# Spaces to indent 'case' from 'switch'

# Usually 0 or indent_columns.

indent_switch_case = 0 # number

'case'行偏移的空格数

# Spaces to shift the 'case' line, without affecting any other lines

# Usually 0.

indent_case_shift = 0 # number

'case' 下'{' 的缩进空格数

# Spaces to indent '{' from 'case'.

# By default, the brace will appear under the 'c' in case.

# Usually set to 0 or indent_columns.

indent_case_brace = 0 # number

是否缩进位于首列的注释

# Whether to indent comments found in first column

indent_col1_comment = false # false/true

如何缩进goto标签

# How to indent goto labels

# >0 : absolute column where 1 is the leftmost column

# <=0 : subtract from brace indent

indent_label = 1 # number

不建议，我就不翻译了……

# If an open paren is followed by a newline, indent the next line so that it lines up after the open paren (not recommended)

indent_paren_nl = false # false/true

控制位于1个新行之后的闭圆括号')'缩进行为

# Controls the indent of a close paren after a newline.

# 0: Indent to body level

# 1: Align under the open paren

# 2: Indent to the brace level

indent_paren_close = 0 # number

控制圆括号内’,’的缩进行为，若为ture，对齐到开圆括号'('之下。

# Controls the indent of a comma when inside a paren.If TRUE, aligns under the open paren

indent_comma_paren = false # false/true

控制圆括号内BOOL operator的缩进行为，若为ture，对齐到开圆括号之下。

# Controls the indent of a BOOL operator when inside a paren.If TRUE, aligns under the open paren

indent_bool_paren = false # false/true

若'indent_bool_paren' 为 true，控制第一个表撒手的缩进，若为ture，对齐第一个表达式到后面的表达式

# If 'indent_bool_paren' is true, controls the indent of the first expression. If TRUE, aligns the first expression to the following ones

indent_first_bool_expr = false # false/true

方括号

# If an open square is followed by a newline, indent the next line so that it lines up after the open square (not recommended)

indent_square_nl = false # false/true

# Don't change the relative indent of ESQL/C 'EXEC SQL' bodies

indent_preserve_sql = false # false/true

对齐连续声明到’=’

# Align continued statements at the '='. Default=True

# If FALSE or the '=' is followed by a newline, the next line is indent one tab.

indent_align_assign = true # false/true

空格(Spacing)

在算术操作符('+', '-', '/', '*', etc)两边添加或移除空格

# Add or remove space around arithmetic operator '+', '-', '/', '*', etc

sp_arith = ignore # ignore/add/remove/force

在赋值操作符('+', '-', '/', '*', etc)两边添加或移除空格

# Add or remove space around assignment operator '=', '+=', etc

sp_assign = ignore # ignore/add/remove/force

c++11标准中，添加或移除lambda capture specification中的相关空格

# Add or remove space around '=' in C++11 lambda capture specifications. Overrides sp_assign

sp_cpp_lambda_assign = ignore # ignore/add/remove/force

# Add or remove space after the capture specification in C++11 lambda.

sp_cpp_lambda_paren = ignore # ignore/add/remove/force

原型中'='两侧的空格

# Add or remove space around assignment operator '=' in a prototype

sp_assign_default = ignore # ignore/add/remove/force

赋值操作符前或后的空格

# Add or remove space before assignment operator '=', '+=', etc. Overrides sp_assign.

sp_before_assign = ignore # ignore/add/remove/force

# Add or remove space after assignment operator '=', '+=', etc. Overrides sp_assign.

sp_after_assign = ignore # ignore/add/remove/force

enum内赋值操作符两侧、前、后空格

# Add or remove space around assignment '=' in enum

sp_enum_assign = ignore # ignore/add/remove/force

# Add or remove space before assignment '=' in enum. Overrides sp_enum_assign.

sp_enum_before_assign = ignore # ignore/add/remove/force

# Add or remove space after assignment '=' in enum. Overrides sp_enum_assign.

sp_enum_after_assign = ignore # ignore/add/remove/force

预处理器连接操作符'##'两侧的空格

# Add or remove space around preprocessor '##' concatenation operator. Default=Add

sp_pp_concat = add # ignore/add/remove/force

预处理器字符化操作符'#'两侧、前的空格

# Add or remove space after preprocessor '#' stringify operator. Also affects the '#@' charizing operator.

sp_pp_stringify = ignore # ignore/add/remove/force

# Add or remove space before preprocessor '#' stringify operator as in '#define x(y) L#y'.

sp_before_pp_stringify = ignore # ignore/add/remove/force

boolean操作符'&&' 和'||'两侧的、比较操作符r '<', '>', '==', etc两侧的空格

# Add or remove space around boolean operators '&&' and '||'

sp_bool = ignore # ignore/add/remove/force

# Add or remove space around compare operator '<', '>', '==', etc

sp_compare = ignore # ignore/add/remove/force

'(' 与 ')'内侧

# Add or remove space inside '(' and ')'

sp_inside_paren = ignore # ignore/add/remove/force

嵌套圆括号之间的空格

# Add or remove space between nested parens

sp_paren_paren = ignore # ignore/add/remove/force

是否平衡嵌套圆括号两侧的空格

# Whether to balance spaces inside nested parens

sp_balance_nested_parens = false # false/true

')' 与'{'之间的空格

# Add or remove space between ')' and '{'

sp_paren_brace = ignore # ignore/add/remove/force

'*'之前的空格

# Add or remove space before pointer star '*'

sp_before_ptr_star = ignore # ignore/add/remove/force

其后没跟变量名的'*'号之前的空格

# Add or remove space before pointer star '*' that isn't followed by a variable name

# If set to 'ignore', sp_before_ptr_star is used instead.

sp_before_unnamed_ptr_star = ignore # ignore/add/remove/force

'*'号之间的空格

# Add or remove space between pointer stars '*'

sp_between_ptr_star = ignore # ignore/add/remove/force

'*'后若跟了单词，其后的空格

# Add or remove space after pointer star '*', if followed by a word.

sp_after_ptr_star = ignore # ignore/add/remove/force

'*'号和'&相关的各种空格，不翻了，累……

# Add or remove space after a pointer star '*', if followed by a func proto/def.

sp_after_ptr_star_func = ignore # ignore/add/remove/force

# Add or remove space after a pointer star '*', if followed by an open paren (function types).

sp_ptr_star_paren = ignore # ignore/add/remove/force

# Add or remove space before a pointer star '*', if followed by a func proto/def.

sp_before_ptr_star_func = ignore # ignore/add/remove/force

# Add or remove space before a reference sign '&'

sp_before_byref = ignore # ignore/add/remove/force

# Add or remove space before a reference sign '&' that isn't followed by a variable name

# If set to 'ignore', sp_before_byref is used instead.

sp_before_unnamed_byref = ignore # ignore/add/remove/force

# Add or remove space after reference sign '&', if followed by a word.

sp_after_byref = ignore # ignore/add/remove/force

# Add or remove space after a reference sign '&', if followed by a func proto/def.

sp_after_byref_func = ignore # ignore/add/remove/force

# Add or remove space before a reference sign '&', if followed by a func proto/def.

sp_before_byref_func = ignore # ignore/add/remove/force

type和word之间的空格

# Add or remove space between type and word. Default=Force

sp_after_type = force # ignore/add/remove/force

'template <' vs 'template<'.

# Add or remove space in 'template <' vs 'template<'.

尖括号相关的各种空格

# If set to ignore, sp_before_angle is used.

sp_template_angle = ignore # ignore/add/remove/force

# Add or remove space before '<>'

sp_before_angle = ignore # ignore/add/remove/force

# Add or remove space inside '<' and '>'

sp_inside_angle = ignore # ignore/add/remove/force

# Add or remove space after '<>'

sp_after_angle = ignore # ignore/add/remove/force

# Add or remove space between '<>' and '(' as found in 'new List<byte>();'

sp_angle_paren = ignore # ignore/add/remove/force

# Add or remove space between '<>' and a word as in 'List<byte> m;'

sp_angle_word = ignore # ignore/add/remove/force

# Add or remove space between '>' and '>' in '>>' (template stuff C++/C# only). Default=Add

sp_angle_shift = add # ignore/add/remove/force

# Permit removal of the space between '>>' in 'foo<bar<int> >' (C++11 only). Default=False

# sp_angle_shift cannot remove the space without this option.

sp_permit_cpp11_shift = false # false/true

'(' 和 'if', 'for', 'switch', 'while'之间的空格

# Add or remove space before '(' of 'if', 'for', 'switch', and 'while'

sp_before_sparen = ignore # ignore/add/remove/force

if 条件式里'(' 和 ')'内的空格，以及分别'('后的空格')'前的空格

# Add or remove space inside if-condition '(' and ')'

sp_inside_sparen = ignore # ignore/add/remove/force

# Add or remove space before if-condition ')'. Overrides sp_inside_sparen.

sp_inside_sparen_close = ignore # ignore/add/remove/force

# Add or remove space before if-condition '('. Overrides sp_inside_sparen.

sp_inside_sparen_open = ignore # ignore/add/remove/force

添加或移除'if', 'for', 'switch', 'while'后面')'之后的空格

# Add or remove space after ')' of 'if', 'for', 'switch', and 'while'

sp_after_sparen = ignore # ignore/add/remove/force

添加或移除'if', 'for', 'switch', 'while'之后')' 和 '{'之间的空格

# Add or remove space between ')' and '{' of 'if', 'for', 'switch', and 'while'

sp_sparen_brace = ignore # ignore/add/remove/force

添加或移除'if', 'for' ,'while'之前';'之前的空声明的空格

# Add or remove space before empty statement ';' on 'if', 'for' and 'while'

sp_special_semi = ignore # ignore/add/remove/force

添加或移除';'前的空格。

# Add or remove space before ';'. Default=Remove

sp_before_semi = remove # ignore/add/remove/force

添加或移除非空'for'语句里的';'前的空格。

# Add or remove space before ';' in non-empty 'for' statements

sp_before_semi_for = ignore # ignore/add/remove/force

添加或移除非空'for'语句里空语句部分的';'前的空格。

# Add or remove space before a semicolon of an empty part of a for statement.

sp_before_semi_for_empty = ignore # ignore/add/remove/force

添加或移除';'后的空格，除非后面跟着注释。

# Add or remove space after ';', except when followed by a comment. Default=Add

sp_after_semi = add # ignore/add/remove/force

条件或移除'for'语句里的非空语句后的';'后的空格

# Add or remove space after ';' in non-empty 'for' statements. Default=Force

sp_after_semi_for = force # ignore/add/remove/force

条件或移除'for'语句里最后一个空语句后的';'后的空格

# Add or remove space after the final semicolon of an empty part of a for statement: for ( ; ; <here> ).

sp_after_semi_for_empty = ignore # ignore/add/remove/force

添加或移除'['之前的空格，(除'[]')

# Add or remove space before '[' (except '[]')

sp_before_square = ignore # ignore/add/remove/force

添加或移除'[]'之前的空格

# Add or remove space before '[]'

sp_before_squares = ignore # ignore/add/remove/force

添加或移除非空'[' 和 ']'的空格

# Add or remove space inside a non-empty '[' and ']'

sp_inside_square = ignore # ignore/add/remove/force

添加或移除','后的空格

# Add or remove space after ','

sp_after_comma = ignore # ignore/add/remove/force

添加或移除','前的空格

# Add or remove space before ','

sp_before_comma = remove # ignore/add/remove/force

添加或移除'(' 和 ' ,'之间的空格。

# Add or remove space between an open paren and comma: '(,' vs '( ,'

sp_paren_comma = force # ignore/add/remove/force

# Add or remove space before the variadic '...' when preceded by a non-punctuator

sp_before_ellipsis = ignore # ignore/add/remove/force

添加或移除类后':'之后的空格

# Add or remove space after class ':'

sp_after_class_colon = ignore # ignore/add/remove/force

添加或移除类后':'之前的空格

# Add or remove space before class ':'

sp_before_class_colon = ignore # ignore/add/remove/force

添加或移除case ':'里':'之前的空格

# Add or remove space before case ':'. Default=Remove

sp_before_case_colon = remove # ignore/add/remove/force

添加或移除'operator'和'operator' 符号之间的空格

# Add or remove space between 'operator' and operator sign

sp_after_operator = ignore # ignore/add/remove/force

添加或移除operator符号和'('之间的空格

# Add or remove space between the operator symbol and the open paren, as in 'operator ++('

sp_after_operator_sym = ignore # ignore/add/remove/force

# Add or remove space after C/D cast, i.e. 'cast(int)a' vs 'cast(int) a' or '(int)a' vs '(int) a'

sp_after_cast = ignore # ignore/add/remove/force

# Add or remove spaces inside cast parens

sp_inside_paren_cast = ignore # ignore/add/remove/force

添加或移除C++ cast中类型和' ('之间的空格

# Add or remove space between the type and open paren in a C++ cast, i.e. 'int(exp)' vs 'int (exp)'

sp_cpp_cast_paren = ignore # ignore/add/remove/force

添加或移除中'sizeof'和'('之间的空格

# Add or remove space between 'sizeof' and '('

sp_sizeof_paren = ignore # ignore/add/remove/force

添加或移除enum 、 struct/union '{'和'}'之间的空格

# Add or remove space inside enum '{' and '}'

sp_inside_braces_enum = ignore # ignore/add/remove/force

# Add or remove space inside struct/union '{' and '}'

sp_inside_braces_struct = ignore # ignore/add/remove/force

添加或移除'{' 和'}'内部的空格

# Add or remove space inside '{' and '}'

sp_inside_braces = ignore # ignore/add/remove/force

添加或移除'{}'内部的空格

# Add or remove space inside '{}'

sp_inside_braces_empty = ignore # ignore/add/remove/force

添加或移除返回类型和函数名之间的空格

# Add or remove space between return type and function name

# A minimum of 1 is forced except for pointer return types.

sp_type_func = ignore # ignore/add/remove/force

添加或移除'('和函数声明，函数定义之间的空格

# Add or remove space between function name and '(' on function declaration

sp_func_proto_paren = ignore # ignore/add/remove/force

# Add or remove space between function name and '(' on function definition

sp_func_def_paren = ignore # ignore/add/remove/force

# Add or remove space inside empty function '()'

sp_inside_fparens = ignore # ignore/add/remove/force

# Add or remove space inside function '(' and ')'

sp_inside_fparen = ignore # ignore/add/remove/force

# Add or remove space inside the first parens in the function type: 'void (*x)(...)'

sp_inside_tparen = ignore # ignore/add/remove/force

# Add or remove between the parens in the function type: 'void (*x)(...)'

sp_after_tparen_close = ignore # ignore/add/remove/force

# Add or remove space between ']' and '(' when part of a function call.

sp_square_fparen = ignore # ignore/add/remove/force

# Add or remove space between ')' and '{' of function

sp_fparen_brace = ignore # ignore/add/remove/force

添加或移除函数调用里函数名和'('之间的空格

# Add or remove space between function name and '(' on function calls

sp_func_call_paren = ignore # ignore/add/remove/force

添加或移除函数调用(无参数时)里函数名和'()'之间的空格

# Add or remove space between function name and '()' on function calls without parameters.

# If set to 'ignore' (the default), sp_func_call_paren is used.

sp_func_call_paren_empty = ignore # ignore/add/remove/force

添加或移除constructor/destructor和'('之间的空格

# Add or remove space between a constructor/destructor and the open paren

sp_func_class_paren = ignore # ignore/add/remove/force

添加或移除'return' 和'('之间的空格

# Add or remove space between 'return' and '('

sp_return_paren = ignore # ignore/add/remove/force

添加或移除'__attribute__'和'('之间的空格

# Add or remove space between '__attribute__' and '('

sp_attribute_paren = ignore # ignore/add/remove/force

添加或移除'defined' 和 '('之间的空格

# Add or remove space between 'defined' and '(' in '#if defined (FOO)'

sp_defined_paren = ignore # ignore/add/remove/force

添加或移除'throw' 和 '('之间的空格

# Add or remove space between 'throw' and '(' in 'throw (something)'

sp_throw_paren = ignore # ignore/add/remove/force

添加或移除'catch'和 '('之间的空格

# Add or remove space between 'catch' and '(' in 'catch (something) { }'

# If set to ignore, sp_before_sparen is used.

sp_catch_paren = ignore # ignore/add/remove/force

添加或移除macro和值之间的空格

# Add or remove space between macro and value

sp_macro = ignore # ignore/add/remove/force

添加或移除宏函数')'和值之间的空格

# Add or remove space between macro function ')' and value

sp_macro_func = ignore # ignore/add/remove/force

添加或移除'else'和'{'之间的空格，如果它们是在同一行的话

# Add or remove space between 'else' and '{' if on the same line

sp_else_brace = ignore # ignore/add/remove/force

添加或移除'}' 和 'else'之间的空格，若它们在同一行

# Add or remove space between '}' and 'else' if on the same line

sp_brace_else = ignore # ignore/add/remove/force

添加或移除'}' 和typedef之间的空格，若它们在同一行

# Add or remove space between '}' and the name of a typedef on the same line

sp_brace_typedef = ignore # ignore/add/remove/force

添加或移除'catch'和'{'之间的空格，若它们在同一行

添加或移除'}'和'catch'之间的空格，若它们在同一行

'try'和 '{'

# Add or remove space between 'catch' and '{' if on the same line

sp_catch_brace = ignore # ignore/add/remove/force

# Add or remove space between '}' and 'catch' if on the same line

sp_brace_catch = ignore # ignore/add/remove/force

# Add or remove space between 'try' and '{' if on the same line

sp_try_brace = ignore # ignore/add/remove/force

添加或移除'::'之间的空格。

# Add or remove space before the '::' operator

sp_before_dc = ignore # ignore/add/remove/force

添加或移除'::'之后的空格

# Add or remove space after the '::' operator

sp_after_dc = ignore # ignore/add/remove/force

添加或移除'!'（'~'、取址'&'、去引用'*'）之后的空格

# Add or remove space after the '!' (not) operator. Default=Remove

sp_not = remove # ignore/add/remove/force

# Add or remove space after the '~' (invert) operator. Default=Remove

sp_inv = remove # ignore/add/remove/force

# Add or remove space after the '&' (address-of) operator. Default=Remove

# This does not affect the spacing after a '&' that is part of a type.

sp_addr = remove # ignore/add/remove/force

# Add or remove space after the '*' (dereference) operator. Default=Remove

# This does not affect the spacing after a '*' that is part of a type.

sp_deref = remove # ignore/add/remove/force

添加或移除'.' or '->'之间的空格

# Add or remove space around the '.' or '->' operators. Default=Remove

sp_member = remove # ignore/add/remove/force

添加或移除正负号'+' or '-'后面的空格

# Add or remove space after '+' or '-', as in 'x = -5' or 'y = +7'. Default=Remove

sp_sign = remove # ignore/add/remove/force

添加或移除'++' and '--'之前的空格

# Add or remove space before or after '++' and '--', as in '(--x)' or 'y++;'. Default=Remove

sp_incdec = remove # ignore/add/remove/force

添加或移除行末反斜杠之前的空格

# Add or remove space before a backslash-newline at the end of a line. Default=Add

sp_before_nl_cont = add # ignore/add/remove/force

# Add or remove space after the scope '+' or '-', as in '-(void) foo;' or '+(int) bar;'

sp_after_oc_scope = ignore # ignore/add/remove/force

添加或移除'b ? t : f'里':'两侧的空格

# Add or remove space around the ':' in 'b ? t : f'

sp_cond_colon = ignore # ignore/add/remove/force

添加或移除'b ? t : f'里'?'两侧的空格

# Add or remove space around the '?' in 'b ? t : f'

sp_cond_question = ignore # ignore/add/remove/force

修正'case'和标号之间的空格

# Fix the spacing between 'case' and the label. Only 'ignore' and 'force' make sense here.

sp_case_label = ignore # ignore/add/remove/force

控制C++注释符号后的空格

# Control the space after the opening of a C++ comment '// A' vs '//A'

sp_cmt_cpp_start = ignore # ignore/add/remove/force

控制#else 或#endif 和行尾注释之间的空格

# Controls the spaces between #else or #endif and a trailing comment

sp_endif_cmt = ignore # ignore/add/remove/force

控制'new', 'delete',以及 'delete[]'后面的空格

# Controls the spaces after 'new', 'delete', and 'delete[]'

sp_after_new = ignore # ignore/add/remove/force

控制行尾或内嵌注释之前的空格

# Controls the spaces before a trailing or embedded comment

sp_before_tr_emb_cmt = ignore # ignore/add/remove/force

控制行尾或内嵌注释之前的空格的数量

# Number of spaces before a trailing or embedded comment

sp_num_before_tr_emb_cmt = 0 # number

对齐(align)

等号对齐在制表符的整数倍上，本例是在第16个字符处对齐

align_on_tabstop

# 对齐的时候,是否要对齐到制表位上。

align_on_tabstop = false # false/true

int xx = 1;

int xxxx = 32;

int xxxx123= 54765475;

int xx = 1;

int xxxx = 32;

int xxxx123 = 54765475;

align_number_left

是否左对齐数字

# Whether to left-align numbers 似乎没起作用？

align_number_left = false # false/true

align_func_params

# Align variable definitions in prototypes and functions 笔者认为align_func_params跟这里的注释不一致

align_func_params = false # false/true

align_same_func_call_params

# Align parameters in single-line functions that have the same name. The function names must already be aligned with each other.对齐只占1行的同名函数，函数名须已实现对齐。貌似是右对齐。

align_same_func_call_params = false # false/true

fun1(56, 85);

fun1(258,369);

int cdeffgfg, ghijk;

fun1(cdeffgfg,ghijk);

fun1(ghijk,cdeffgfg);

fun1( 56, 85);

fun1(258,369);

int cdeffgfg, ghijk;

fun1(cdeffgfg, ghijk);

fun1( ghijk,cdeffgfg);

变量定义对齐的行数

align_var_def_span

根据老衲观察，此值越大，被对齐的等号越多，具体含义，暂时没摸清。

# The span for aligning variable definitions (0=don't align)

align_var_def_span = 0 # number

变量定义对齐的门限

align_var_def_thresh

对齐门限，变量定义对齐时，变量最多移动的步(插入的空格)数。对某一行而言，若为了对齐，插入的空格数大于此值，则此行不作改变。

# The threshold for aligning variable definitions (0=no limit)

align_var_def_thresh = 0 # number

align_var_def_gap

变量定义对齐时，类型名与变量名之间的间距(即空格数)。当然，只有变量定义对齐起作用时，这一项才会起作用。

# The gap for aligning variable definitions

align_var_def_gap = 0 # number

align_var_def_colon

是否对齐结构体位域的’:’

# Whether to align the colon in struct bit fields

align_var_def_colon = false # false/true

align_var_def_inline

是否对齐inline struct/enum/union里的变量定义

# Whether to align inline struct/enum/union variable definitions **Wenquanwudi**启用试试

align_var_def_inline = false # false/true

这个span的具体含义我现在还没摸清。。。隐隐约约的指作用的行数，新行也算。

align_assign_span

赋值表达式对齐的范围，此值越大，对齐的等号越多

# The span for aligning on '=' in assignments (0=don't align) **Wenquanwudi** 等号对齐

align_assign_span = 0 # number

赋值表达式对齐的门限，参见align_var_def_thresh

# The threshold for aligning on '=' in assignments (0=no limit)

align_assign_thresh = 0 # number

下面选项不再赘述，范围限制在enum,struct,union里而已。

# The span for aligning on '=' in enums (0=don't align) **Wenquanwudi**启用试试

align_enum_equ_span = 0 # number

# The threshold for aligning on '=' in enums (0=no limit)

align_enum_equ_thresh = 0 # number

# The span for aligning struct/union (0=don't align) **Wenquanwudi**启用试试

align_var_struct_span = 0 # number

# The threshold for aligning struct/union member definitions (0=no limit)

align_var_struct_thresh = 0 # number

# The gap for aligning struct/union member definitions

align_var_struct_gap = 0 # number

# The span for aligning struct initializer values (0=don't align) **Wenquanwudi**启用试试

align_struct_init_span = 0 # number

typedef语句中，原类型和别名之间的间距

# The minimum space between the type and the synonym of a typedef

align_typedef_gap = 0 # number

单行typedef的对齐范围

# The span for aligning single-line typedefs (0=don't align) **Wenquanwudi**启用试试

align_typedef_span = 0 # number

align_typedef_star_style

控制 “*”在typedef中的位置

# Controls the positioning of the '*' in typedefs. Just try it. **Wenquanwudi**我觉得2好点

# 0: Align on typedef type, ignore '*'

# 1: The '*' is part of type name: typedef int *pint;

# 2: The '*' is part of the type, but dangling: typedef int *pint;

align_typedef_star_style = 0 # number

控制 “&”在typedef中的位置

# Controls the positioning of the '&' in typedefs. Just try it. **Wenquanwudi**我觉得2好点

# 0: Align on typedef type, ignore '&'

# 1: The '&' is part of type name: typedef int &pint;

# 2: The '&' is part of the type, but dangling: typedef int &pint;

align_typedef_amp_style = 0 # number

align_right_cmt_span

对齐右侧的注释的范围，即行尾的注释啰

# The span for aligning comments that end lines (0=don't align)

align_right_cmt_span = 0 # number

align_right_cmt_mix

# If aligning comments, mix with comments after '}' and #endif with less than 3 spaces before the comment **Wenquanwudi**我觉得true好点

align_right_cmt_mix = false # false/true

align_right_cmt_gap

离语句多远的行尾注释会被对齐

# If a trailing comment is more than this number of columns away from the text it follows,**Wenquanwudi**离语句多远的注释会被对齐，当然，行尾注释对齐选项起作用时该选项才能发挥作用。

# it will qualify for being aligned. This has to be > 0 to do anything.

align_right_cmt_gap = 0 # number

align_right_cmt_at_col

将行尾注释对齐在多少列

# Align trailing comment at or beyond column N; 'pulls in' comments as a bonus side effect (0=ignore) **Wenquanwudi**

align_right_cmt_at_col = 0 # number

align_func_proto_span

函数原型对齐的范围

# The span for aligning function prototypes (0=don't align) **Wenquanwudi**我的建议是要对齐，函数原型对齐

align_func_proto_span = 0 # number

关于函数原型对齐

align_func_proto_gap

函数原型对齐时，return type 和function name之间的间距

# Minimum gap between the return type and the function name. **Wenquanwudi**函数原型对齐时，return type 和function name之间的间距

align_func_proto_gap = 0 # number

？？？

# Align function protos on the 'operator' keyword instead of what follows

align_on_operator = false # false/true

align_mix_var_proto

函数原型(函数原型也包括函数调用)和变量声明是否要混在一起对齐

# Whether to mix aligning prototype and variable declarations.

# If true, align_var_def_XXX options are used instead of align_func_proto_XXX options.

align_mix_var_proto = false # false/true

对齐单行函数。

# Align single-line functions with function prototypes, uses align_func_proto_span

align_single_line_func = false # false/true

# Aligning the open brace of single-line functions.

# Requires align_single_line_func=true, uses align_func_proto_span

align_single_line_brace = false # false/true

# Gap for align_single_line_brace.

align_single_line_brace_gap = 0 # number

# Whether to align macros wrapped with a backslash and a newline.

# This will not work right if the macro contains a multi-line comment.

align_nl_cont = false # false/true

函数原型对齐

void fun1(int a, int b);

int fun2(float cdfefe, float dfd);

void fun1(int a, int b);

int fun2(float cdfefe, float dfd);

align_pp_define_together

宏函数和变量放在一起对齐

# # Align macro functions and variables together

align_pp_define_together = false # false/true

宏定义值和宏名之间的最小间距

# The minimum space between label and value of a preprocessor define

align_pp_define_gap = 0 # number

'#define体的对齐范围

# The span for aligning on '#define' bodies (0=don't align)

align_pp_define_span = 0 # number

对齐'<<'开头的行

# Align lines that start with '<<' with previous '<<'. Default=true

align_left_shift = true # false/true

新行添加与移除

# Newline adding and removing options

是否折叠空{}

# Whether to collapse empty blocks between '{' and '}'

nl_collapse_empty_body = false # false/true

if()

{}

if()

{

}

不划开单行大括号赋值

# Don't split one-line braced assignments - 'foo_t f = { 1, 2 };'

nl_assign_leave_one_liners = false # false/true

不划开class内的的单行声明

# Don't split one-line braced statements inside a class xx { } body

nl_class_leave_one_liners = false # false/true

不划开单行enum

# Don't split one-line enums: 'enum foo { BAR = 15 };'

nl_enum_leave_one_liners = false # false/true

不划开单行函数定义

# Don't split one-line function definitions - 'int foo() { return 0; }'

nl_func_leave_one_liners = false # false/true

不划开单行if/else声明

# Don't split one-line if/else statements - 'if(a) b++;'

nl_if_leave_one_liners = false # false/true

添加或移除文件开头的新行

# Add or remove newlines at the start of the file

nl_start_of_file = ignore # ignore/add/remove/force

文件开头(要添加或要移除)的新行数

# The number of newlines at the start of the file (only used if nl_start_of_file is 'add' or 'force'

nl_start_of_file_min = 0 # number

同上，文件尾

# Add or remove newline at the end of the file

nl_end_of_file = ignore # ignore/add/remove/force

# The number of newlines at the end of the file (only used if nl_end_of_file is 'add' or 'force')

nl_end_of_file_min = 0 # number

在'=' 和 '{'间添加或移除新行

# Add or remove newline between '=' and '{'

nl_assign_brace = ignore # ignore/add/remove/force

函数体顶部的变量定义块之后的新行数

# The number of blank lines after a block of variable definitions at the top of a function body

# 0 = No change (default)

nl_func_var_def_blk = 0 # number

typedef块之前的新行数量

# The number of newlines before a block of typedefs

# 0 = No change (default)

nl_typedef_blk_start = 0 # number

typedef块之后的新行数量

# The number of newlines after a block of typedefs

# 0 = No change (default)

nl_typedef_blk_end = 0 # number

在typedef块内最大连续新行数

# The maximum consecutive newlines within a block of typedefs

# 0 = No change (default)

nl_typedef_blk_in = 0 # number

不在函数体顶部的变量定义块之前的新行数

# The number of newlines before a block of variable definitions not at the top of a function body

# 0 = No change (default)

nl_var_def_blk_start = 0 # number

不在函数体顶部的变量定义块之后的新行数

# The number of newlines after a block of variable definitions not at the top of a function body

# 0 = No change (default)

nl_var_def_blk_end = 0 # number

变量定义块之间最大连续新行数

# The maximum consecutive newlines within a block of variable definitions

# 0 = No change (default)

nl_var_def_blk_in = 0 # number

添加或删除enum、struct、union、if，else if与'{'之间，'}'和 'else'之间等等等等的新行

# Add or remove newline between 'enum' and '{'

nl_enum_brace = ignore # ignore/add/remove/force

# Add or remove newline between 'struct and '{'

nl_struct_brace = ignore # ignore/add/remove/force

# Add or remove newline between 'union' and '{'

nl_union_brace = ignore # ignore/add/remove/force

# Add or remove newline between 'if' and '{'

nl_if_brace = ignore # ignore/add/remove/force

# Add or remove newline between '}' and 'else'

nl_brace_else = ignore # ignore/add/remove/force

# Add or remove newline between 'else if' and '{'

# If set to ignore, nl_if_brace is used instead

nl_elseif_brace = ignore # ignore/add/remove/force

# Add or remove newline between 'else' and '{'

nl_else_brace = ignore # ignore/add/remove/force

# Add or remove newline between 'else' and 'if'

nl_else_if = ignore # ignore/add/remove/force

# Add or remove newline between 'finally' and '{'

nl_finally_brace = ignore # ignore/add/remove/force

# Add or remove newline between 'try' and '{'

nl_try_brace = ignore # ignore/add/remove/force

# Add or remove newline between 'for' and '{'

nl_for_brace = ignore # ignore/add/remove/force

# Add or remove newline between 'catch' and '{'

nl_catch_brace = ignore # ignore/add/remove/force

# Add or remove newline between '}' and 'catch'

nl_brace_catch = ignore # ignore/add/remove/force

# Add or remove newline between 'while' and '{'

nl_while_brace = ignore # ignore/add/remove/force

# Add or remove newline between 'using' and '{'

nl_using_brace = ignore # ignore/add/remove/force

# Add or remove newline between two open or close braces.

# Due to general newline/brace handling, REMOVE may not work.

nl_brace_brace = ignore # ignore/add/remove/force

# Add or remove newline between 'do' and '{'

nl_do_brace = ignore # ignore/add/remove/force

# Add or remove newline between '}' and 'while' of 'do' statement

nl_brace_while = ignore # ignore/add/remove/force

# Add or remove newline between 'switch' and '{'

nl_switch_brace = ignore # ignore/add/remove/force

# Add a newline between ')' and '{' if the ')' is on a different line than the if/for/etc.

# Overrides nl_for_brace, nl_if_brace, nl_switch_brace, nl_while_switch, and nl_catch_brace.

nl_multi_line_cond = false # false/true

为多行define强制在macro名之后添加1个新行。

# Force a newline in a define after the macro name for multi-line defines.

nl_multi_line_define = false # false/true

是否在'case'之前添加新行

# Whether to put a newline before 'case' statement

nl_before_case = false # false/true

添加或移除')' 和 'throw'之间的新行

# Add or remove newline between ')' and 'throw'

nl_before_throw = ignore # ignore/add/remove/force

是否在'case'之后添加新行

# Whether to put a newline after 'case' statement

nl_after_case = false # false/true

case ':' 和 '{'之间的新行

# Add or remove a newline between a case ':' and '{'. Overrides nl_after_case.

nl_case_colon_brace = ignore # ignore/add/remove/force

# Newline between namespace and {

nl_namespace_brace = ignore # ignore/add/remove/force

在'template<>'和其后内容之间添加新行

# Add or remove newline between 'template<>' and whatever follows.

nl_template_class = ignore # ignore/add/remove/force

# Add or remove newline between 'class' and '{'

nl_class_brace = ignore # ignore/add/remove/force

# Add or remove newline after each ',' in the constructor member initialization

nl_class_init_args = ignore # ignore/add/remove/force

# Add or remove newline between return type and function name in a function definition

nl_func_type_name = ignore # ignore/add/remove/force

# Add or remove newline between return type and function name inside a class {}

# Uses nl_func_type_name or nl_func_proto_type_name if set to ignore.

nl_func_type_name_class = ignore # ignore/add/remove/force

# Add or remove newline between function scope and name in a definition

# Controls the newline after '::' in 'void A::f() { }'

nl_func_scope_name = ignore # ignore/add/remove/force

# Add or remove newline between return type and function name in a prototype

nl_func_proto_type_name = ignore # ignore/add/remove/force

# Add or remove newline between a function name and the opening '('

nl_func_paren = ignore # ignore/add/remove/force

# Add or remove newline between a function name and the opening '(' in the definition

nl_func_def_paren = ignore # ignore/add/remove/force

# Add or remove newline after '(' in a function declaration

nl_func_decl_start = ignore # ignore/add/remove/force

# Add or remove newline after '(' in a function definition

nl_func_def_start = ignore # ignore/add/remove/force

# Overrides nl_func_decl_start when there is only one parameter.

nl_func_decl_start_single = ignore # ignore/add/remove/force

# Overrides nl_func_def_start when there is only one parameter.

nl_func_def_start_single = ignore # ignore/add/remove/force

# Add or remove newline after each ',' in a function declaration

nl_func_decl_args = ignore # ignore/add/remove/force

# Add or remove newline after each ',' in a function definition

nl_func_def_args = ignore # ignore/add/remove/force

# Add or remove newline before the ')' in a function declaration

nl_func_decl_end = ignore # ignore/add/remove/force

# Add or remove newline before the ')' in a function definition

nl_func_def_end = ignore # ignore/add/remove/force

# Overrides nl_func_decl_end when there is only one parameter.

nl_func_decl_end_single = ignore # ignore/add/remove/force

# Overrides nl_func_def_end when there is only one parameter.

nl_func_def_end_single = ignore # ignore/add/remove/force

# Add or remove newline between '()' in a function declaration.

nl_func_decl_empty = ignore # ignore/add/remove/force

# Add or remove newline between '()' in a function definition.

nl_func_def_empty = ignore # ignore/add/remove/force

在函数签名和'{'添加或移除新行

# Add or remove newline between function signature and '{'

nl_fdef_brace = ignore # ignore/add/remove/force

# Add or remove a newline between the return keyword and return expression.

nl_return_expr = ignore # ignore/add/remove/force

是否在 ‘;’ 后添加新行(for语句里除外)

# Whether to put a newline after semicolons, except in 'for' statements

nl_after_semicolon = false # false/true

是否在‘{’后添加新行,该选项同时会在’}’前添加新行

# Whether to put a newline after brace open.

# This also adds a newline before the matching brace close.

nl_after_brace_open = false # false/true

# If nl_after_brace_open and nl_after_brace_open_cmt are true, a newline is

# placed between the open brace and a trailing single-line comment.

nl_after_brace_open_cmt = false # false/true

# Whether to put a newline after a virtual brace open with a non-empty body.

# These occur in un-braced if/while/do/for statement bodies.

nl_after_vbrace_open = false # false/true

# Whether to put a newline after a virtual brace open with an empty body.

# These occur in un-braced if/while/do/for statement bodies.

nl_after_vbrace_open_empty = false # false/true

# Whether to put a newline after a brace close.

# Does not apply if followed by a necessary ';'.

nl_after_brace_close = false # false/true

# Whether to put a newline after a virtual brace close.

# Would add a newline before return in: 'if (foo) a++; return;'

nl_after_vbrace_close = false # false/true

enums, unions以及 struct后的尾’ }’之后是否加新行

# Control the newline between the close brace and 'b' in: 'struct { int a; } b;'

# Affects enums, unions, and structures. If set to ignore, uses nl_after_brace_close

nl_brace_struct_var = ignore # ignore/add/remove/force

# Whether to alter newlines in '#define' macros

nl_define_macro = false # false/true

是否在 '#ifxx', '#elxx'之后，'#endif'之前，'if'、'for'、'while'、'switch'、'do'等等前后添加新行

# Whether to not put blanks after '#ifxx', '#elxx', or before '#endif'

nl_squeeze_ifdef = false # false/true

# Add or remove blank line before 'if'

nl_before_if = ignore # ignore/add/remove/force

# Add or remove blank line after 'if' statement

nl_after_if = ignore # ignore/add/remove/force

# Add or remove blank line before 'for'

nl_before_for = ignore # ignore/add/remove/force

# Add or remove blank line after 'for' statement

nl_after_for = ignore # ignore/add/remove/force

# Add or remove blank line before 'while'

nl_before_while = ignore # ignore/add/remove/force

# Add or remove blank line after 'while' statement

nl_after_while = ignore # ignore/add/remove/force

# Add or remove blank line before 'switch'

nl_before_switch = ignore # ignore/add/remove/force

# Add or remove blank line after 'switch' statement

nl_after_switch = ignore # ignore/add/remove/force

# Add or remove blank line before 'do'

nl_before_do = ignore # ignore/add/remove/force

# Add or remove blank line after 'do/while' statement

nl_after_do = ignore # ignore/add/remove/force

是否双空格

# Whether to double-space commented-entries in struct/enum

nl_ds_struct_enum_cmt = false # false/true

# Whether to double-space before the close brace of a struct/union/enum

# (lower priority than 'eat_blanks_before_close_brace')

nl_ds_struct_enum_close_brace = false # false/true

# Add or remove a newline around a class colon.

# Related to pos_class_colon, nl_class_init_args, and pos_comma.

nl_class_colon = ignore # ignore/add/remove/force

将单行未加'{}'语句格式化成1行。If, for, while

# Change simple unbraced if statements into a one-liner

# 'if(b)\n i++;' => 'if(b) i++;'

nl_create_if_one_liner = false # false/true

# Change simple unbraced for statements into a one-liner

# 'for (i=0;i<5;i++)\n foo(i);' => 'for (i=0;i<5;i++) foo(i);'

nl_create_for_one_liner = false # false/true

# Change simple unbraced while statements into a one-liner

# 'while (i<5)\n foo(i++);' => 'while (i<5) foo(i++);'

nl_create_while_one_liner = false # false/true

位置

# Positioning options

# The position of arithmetic operators in wrapped expressions

pos_arith = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force

# The position of assignment in wrapped expressions.

# Do not affect '=' followed by '{'

pos_assign = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force

# The position of boolean operators in wrapped expressions

pos_bool = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force

# The position of comparison operators in wrapped expressions

pos_compare = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force

# The position of conditional (b ? t : f) operators in wrapped expressions

pos_conditional = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force

# The position of the comma in wrapped expressions

pos_comma = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force

# The position of the comma in the constructor initialization list

pos_class_comma = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force

# The position of colons between constructor and member initialization

pos_class_colon = ignore # ignore/join/lead/lead_break/lead_force/trail/trail_break/trail_force

行划分

# Line Splitting options

尝试将1行代码的宽度限制到N个字符

# Try to limit code width to N number of columns

code_width = 0 # number

是否完整地在’;’之后划分长for语句。

# Whether to fully split long 'for' statements at semi-colons

ls_for_split_full = false # false/true

是否完整地在’,’之后划分长函数原型

# Whether to fully split long function protos/calls at commas

ls_func_split_full = false # false/true

是否尽可能地依照code_width划分行，而无视一些grouping。

# Whether to split lines as close to code_width as possible and ignore some groupings

ls_code_width = false # false/true

空行

空行即新行，新行即空行，不必在意。

最大连续新行

# The maximum consecutive newlines

nl_max = 0 # number

函数原型之后的新行，若此函数原型其后也跟着1个函数原型的话

# The number of newlines after a function prototype, if followed by another function prototype

nl_after_func_proto = 0 # number

函数原型之后的新行，若此函数原型其后没有跟着1个函数原型的话

# The number of newlines after a function prototype, if not followed by another function prototype

nl_after_func_proto_group = 0 # number

多行函数体'}'之后的新行数

# The number of newlines after '}' of a multi-line function body

nl_after_func_body = 0 # number

在一个类声明里，多行函数体'}'之后的新行数

# The number of newlines after '}' of a multi-line function body in a class declaration

nl_after_func_body_class = 0 # number

单行函数体'}'之后的新行数

# The number of newlines after '}' of a single line function body

nl_after_func_body_one_liner = 0 # number

多行注释之前的最少空行数

# The minimum number of newlines before a multi-line comment.

# Doesn't apply if after a brace open or another multi-line comment.

nl_before_block_comment = 0 # number

单行C注释之前的最少空行数

# The minimum number of newlines before a single-line C comment.

# Doesn't apply if after a brace open or other single-line C comments.

nl_before_c_comment = 0 # number

CPP注释之前的最少空行数

# The minimum number of newlines before a CPP comment.

# Doesn't apply if after a brace open or other CPP comments.

nl_before_cpp_comment = 0 # number

是否强制在多行注释之后添加1个空行

# Whether to force a newline after a multi-line comment.

nl_after_multiline_comment = false # false/true

在struct/enum/union定义的'}' 或 ';'之后添加的空行数

# The number of newlines after '}' or ';' of a struct/enum/union definition

nl_after_struct = 0 # number

在class定义的'}' 或 ';'之后添加的空行数

# The number of newlines after '}' or ';' of a class definition

nl_after_class = 0 # number

在'private:', 'public:', 'protected:', 'signals:', 或 'slots:' 标签前添加的新行数

# The number of newlines before a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label.

# Will not change the newline count if after a brace open.

# 0 = No change.

nl_before_access_spec = 0 # number

在'private:', 'public:', 'protected:', 'signals:', 或 'slots:' 标签后添加的新行数

# The number of newlines after a 'private:', 'public:', 'protected:', 'signals:', or 'slots:' label.

# 0 = No change.

nl_after_access_spec = 0 # number

函数定义和函数注释之前的新行数

# The number of newlines between a function def and the function comment.

# 0 = No change.

nl_comment_func_def = 0 # number

是否移除'{'之后的空行

# Whether to remove blank lines after '{'

eat_blanks_after_open_brace = false # false/true

是否移除'}'之前的空行

# Whether to remove blank lines before '}'

eat_blanks_before_close_brace = false # false/true

预处理中，应如何移除多余的新行

# How aggressively to remove extra newlines not in preproc.

# 0: No change

# 1: Remove most newlines not handled by other config

# 2: Remove all newlines and reformat completely by config

nl_remove_extra_newlines = 0 # number

是否在'return'语句之前添加空行，除非在一个开花括号之后。

# Whether to put a blank line before 'return' statements, unless after an open brace.

nl_before_return = false # false/true

是否在'return'语句之后添加空行，除非在一个开花括号之前

# Whether to put a blank line after 'return' statements, unless followed by a close brace.

nl_after_return = false # false/true

代码修改(非空格)

给do,for, ,if等等后面的单行块添加或移除花括号

# Add or remove braces on single-line 'do' statement

mod_full_brace_do = ignore # ignore/add/remove/force

# Add or remove braces on single-line 'for' statement

mod_full_brace_for = ignore # ignore/add/remove/force

# Add or remove braces on single-line 'if' statement. Will not remove the braces if they contain an 'else'.

mod_full_brace_if = ignore # ignore/add/remove/force

移除或添加整个if/elseif/else系列的花括号

# Make all if/elseif/else statements in a chain be braced or not. Overrides mod_full_brace_if.

# If any must be braced, they are all braced. If all can be unbraced, then the braces are removed.

mod_full_brace_if_chain = false # false/true

不移除跨越N行声明的花括号，N由该值指定。

# Don't remove braces around statements that span N newlines

mod_full_brace_nl = 0 # number

# Add or remove braces on single-line 'while' statement

mod_full_brace_while = ignore # ignore/add/remove/force

# Add or remove braces on single-line 'using ()' statement

mod_full_brace_using = ignore # ignore/add/remove/force

# Add or remove unnecessary paren on 'return' statement

mod_paren_on_return = ignore # ignore/add/remove/force

是否移除多余的’;’

# Whether to remove superfluous semicolons

mod_remove_extra_semicolon = false # false/true

若一个函数体、switch体，#ifdef体，# #else体等等超过指定的新行数，且在闭花括号后没有注释，那么，注释会被添加。

# If a function body exceeds the specified number of newlines and doesn't have a comment after

# the close brace, a comment will be added.

mod_add_long_function_closebrace_comment = 0 # number

# If a switch body exceeds the specified number of newlines and doesn't have a comment after

# the close brace, a comment will be added.

mod_add_long_switch_closebrace_comment = 0 # number

# If an #ifdef body exceeds the specified number of newlines and doesn't have a comment after

# the #endif, a comment will be added.

mod_add_long_ifdef_endif_comment = 0 # number

# If an #ifdef or #else body exceeds the specified number of newlines and doesn't have a comment after

# the #else, a comment will be added.

mod_add_long_ifdef_else_comment = 0 # number

若为true，将会对连续的单行'#include'语句排序，不推荐。

# If TRUE, will sort consecutive single-line '#include' statements [C/C++]

# This is generally a bad idea, as it may break your code.

mod_sort_include = false # false/true

若为true，将会将位于完整花括号之后的'break'移动到闭花括号之内

# If TRUE, it will move a 'break' that appears after a fully braced 'case' before the close brace.

mod_move_case_break = false # false/true

给case语句添加或移除花括号

# Will add or remove the braces around a fully braced case statement.

# Will only remove the braces if there are no variable declarations in the block.

mod_case_brace = ignore # ignore/add/remove/force

若为true，则移除函数末的空'return;'

# If TRUE, it will remove a void 'return;' that appears as the last statement in a function.

mod_remove_empty_return = false # false/true

注释修改

若在第cmt_width列有注释，则在此列(若此列是单词末尾的话，否则继续后退到单词末尾那一列)换行，看例子cmt_width=20的情形。

# Try to wrap comments at cmt_width columns

cmt_width = 0 # number

int a; //nihao

int b; //meiyou ,wo buhao

int ds;

int a; //nihao

int b; //meiyou ,wo

// buhao

int ds;

设置注释换行模式

# Set the comment reflow mode (default: 0)

# 0: no reflowing (apart from the line wrapping due to cmt_width)

# 1: no touching at all

# 2: full reflow

cmt_reflow_mode = 0 # number

缩进多行注释，若为false，所有多行注释改变皆禁用

# If false, disable all multi-line comment changes, including cmt_width. keyword substitution, and leading chars.

# Default is true.

cmt_indent_multi = true # false/true

ni mei a

wo mei

ta mei

da jia mei

ni mei a

wo mei

ta mei

da jia mei

是否将C注释成组，使得他们看起来像在1个组内

# Whether to group c-comments that look like they are in a block

cmt_c_group = false # false/true

/* tao yan ni */

/* tao yan ni

tao yan ni

tao yan ni */

是否在联合C注释的首行、末行添加空'/*'

# Whether to put an empty '/*' on the first line of the combined c-comment

cmt_c_nl_start = false # false/true

# Whether to put a newline before the closing '*/' of the combined c-comment

cmt_c_nl_end = false # false/true

cpp注释，不再赘述

# Whether to group cpp-comments that look like they are in a block

cmt_cpp_group = false # false/true

# Whether to put an empty '/*' on the first line of the combined cpp-comment

cmt_cpp_nl_start = false # false/true

# Whether to put a newline before the closing '*/' of the combined cpp-comment

cmt_cpp_nl_end = false # false/true

是否将cpp注释更改为C注释

# Whether to change cpp-comments into c-comments

cmt_cpp_to_c = false # false/true

是否给连续注释行的行首添加’*’

# Whether to put a star on subsequent comment lines

cmt_star_cont = false # false/true

’*’号前后的空格数，不过貌似不起作用

# The number of spaces to insert at the start of subsequent comment lines

cmt_sp_before_star_cont = 0 # number

# The number of spaces to insert after the star on subsequent comment lines

cmt_sp_after_star_cont = 0 # number

貌似不起作用呢？

# For multi-line comments with a '*' lead, remove leading spaces if the first and last lines of

# the comment are the same length. Default=True

cmt_multi_check_last = true # false/true

若文件头部、class头部插入的文件名(包含文本)没有以c/c++注释开始(结束)，则将此文件名替换为当前文件名cmt_insert_file_header(cmt_insert_file_footer)

# The filename that contains text to insert at the head of a file if the file doesn't start with a C/C++ comment.

# Will substitute $(filename) with the current file's name.

cmt_insert_file_header = "" # string

# The filename that contains text to insert at the end of a file if the file doesn't end with a C/C++ comment.

# Will substitute $(filename) with the current file's name.

cmt_insert_file_footer = "" # string

# The filename that contains text to insert before a class if the class isn't preceded with a C/C++ comment.

# Will substitute $(class) with the class name.

cmt_insert_class_header = "" # string

# If a preprocessor is encountered when stepping backwards from a function name, then

# this option decides whether the comment should be inserted.

# Affects cmt_insert_oc_msg_header, cmt_insert_func_header and cmt_insert_class_header.

cmt_insert_before_preproc = false # false/true

预处理

# Preprocessor options

控制预处理#if块的缩进级别。

# Control indent of preprocessors inside #if blocks at brace level 0

pp_indent = ignore # ignore/add/remove/force

ture，#if/#else/#endif以花括号级别缩进，否则在列1缩进

# Whether to indent #if/#else/#endif at the brace level (true) or from column 1 (false)

pp_indent_at_level = false # false/true

若pp_indent_at_level=false，指定预处理每级别的缩进列数

# If pp_indent_at_level=false, specifies the number of columns to indent per level. Default=1.

pp_indent_count = 1 # number

基于#if块的pp_level，添加或移除#号后的空格

# Add or remove space after # based on pp_level of #if blocks

pp_space = ignore # ignore/add/remove/force

设定pp_space的数量

# Sets the number of spaces added with pp_space

pp_space_count = 0 # number

'#pragma region'的缩进列数

# The indent for #region and #endregion in C# and '#pragma region' in C/C++

pp_indent_region = 0 # number

若pp_indent_at_level=true，设定不在file-level时的#if, #else, #endif缩进列数

# If pp_indent_at_level=true, sets the indent for #if, #else, and #endif when not at file-level

pp_indent_if = 0 # number

控制非file-level时的#if, #else, #endif缩进级别

# Control whether to indent the code between #if, #else and #endif when not at file-level

pp_if_indent_code = false # false/true

以花括号级别缩进，还是在列1缩进'#define'。

# Whether to indent '#define' at the brace level (true) or from column 1 (false)

pp_define_at_level = false # false/true

实例

 
#
# General options
#
 
# The type of line endings
newlines                      = auto     # auto/lf/crlf/cr
 
# The original size of tabs in the input
input_tab_size                = 4        # number
 
# The size of tabs in the output (only used if align_with_tabs=true)
output_tab_size               = 4        # number
 
# The ascii value of the string escape char, usually 92 (\). (Pawn)
string_escape_char            = 92       # number
 
#
# Indenting
#
 
# The number of columns to indent per level.
# Usually 2, 3, 4, or 8.
indent_columns                = 4        # number
 
# How to use tabs when indenting code
# 0=spaces only
# 1=indent with tabs, align with spaces
# 2=indent and align with tabs
indent_with_tabs              = 1        # number
 
# Whether to indent strings broken by '\' so that they line up
indent_align_string           = false    # false/true
# The number of spaces to indent multi-line XML strings.
# Requires indent_align_string=True
indent_xml_string             = 0        # number
# Spaces to indent '{' from level
indent_brace                  = 0        # number
# Whether braces are indented to the body level
indent_braces                 = false    # false/true
# Disabled indenting function braces if indent_braces is true
indent_braces_no_func         = false    # false/true
# Indent based on the size of the brace parent, ie 'if' => 3 spaces, 'for' => 4 spaces, etc.
indent_brace_parent           = false    # false/true
 
# Whether the 'namespace' body is indented
indent_namespace              = true    # false/true
 
# Whether the 'class' body is indented
indent_class                  = true    # false/true
 
# Whether to indent the stuff after a leading class colon
indent_class_colon            = false    # false/true
 
# Whether to indent continued function call parameters one indent level (true) or aligns instead of indent (false)
indent_func_call_param        = false    # false/true
 
# The number of spaces to indent a continued '->' or '.'
# Usually set to 0, 1, or indent_columns.
indent_member                 = 0        # number
 
# Spaces to indent single line ('//') comments on lines before code
indent_sing_line_comments     = 0        # number
 
# Spaces to indent 'case' from 'switch'
# Usually 0 or indent_columns.
indent_switch_case            = 0        # number
 
# Spaces to shift the 'case' line, without affecting any other lines
# Usually 0.
indent_case_shift             = 0        # number
 
# Spaces to indent '{' from 'case'.
# By default, the brace will appear under the 'c' in case.
# Usually set to 0 or indent_columns.
indent_case_brace             = 0        # number
 
# Whether to indent comments found in first column
indent_col1_comment           = true    # false/true
 
# How to indent goto labels
#  >0 : absolute column where 1 is the leftmost column
#  <=0 : subtract from brace indent
indent_label                  = 1        # number
 
# Same as indent_label, but for access specifiers that are followed by a colon
indent_access_spec            = 1        # number
 
# If an open paren is followed by a newline, indent the next line so that it lines up after the open paren (not recommended)
indent_paren_nl               = false    # false/true
 
# If an open square is followed by a newline, indent the next line so that it lines up after the open square (not recommended)
indent_square_nl              = false    # false/true
 
#
# Spacing options
#
 
# Add or remove space around arithmetic operator '+', '-', '/', '*', etc
#Note: it will be no space around if set to FORCE
sp_arith                      = force   # ignore/add/remove/force
 
# Add or remove space around assignment operator '=', '+=', etc
sp_assign                     = force   # ignore/add/remove/force
 
# Add or remove space around boolean operators '&&' and '||'
sp_bool                       = force   # ignore/add/remove/force
 
# Add or remove space around compare operator '<', '>', '==', etc
sp_compare                    = force   # ignore/add/remove/force
 
# Add or remove space inside '(' and ')'
sp_inside_paren               = remove   # ignore/add/remove/force
 
# Add or remove space between nested parens
sp_paren_paren                = remove   # ignore/add/remove/force
 
# Whether to balance spaces inside nested parens
sp_balance_nested_parens      = false    # false/true
 
# Add or remove space between ')' and '{'
sp_paren_brace                = add   # ignore/add/remove/force
 
# Add or remove space before pointer star '*'
sp_before_ptr_star            = remove   # ignore/add/remove/force
 
# Add or remove space between pointer stars '*'
sp_between_ptr_star           = remove   # ignore/add/remove/force
 
# Add or remove space after pointer star '*'
sp_after_ptr_star             = add   # ignore/add/remove/force
 
# Add or remove space before reference sign '&'
sp_before_byref               = remove   # ignore/add/remove/force
 
# Add or remove space after reference sign '&'
sp_after_byref                = add   # ignore/add/remove/force
 
# Add or remove space before '<>'
sp_before_angle               = force   # ignore/add/remove/force
 
# Add or remove space after '<>'
sp_after_angle                = force   # ignore/add/remove/force
 
# Add or remove space between '<>' and '(' as found in 'new List<byte>();'
sp_angle_paren                = ignore   # ignore/add/remove/force
 
# Add or remove space between '<>' and a word as in 'List<byte> m;'
sp_angle_word                 = ignore   # ignore/add/remove/force
 
# Add or remove space before '(' of 'if', 'for', 'switch', and 'while'
sp_before_sparen              = force   # ignore/add/remove/force
 
# Add or remove space inside if-condition '(' and ')'
sp_inside_sparen              = remove   # ignore/add/remove/force
 
# Add or remove space after ')' of 'if', 'for', 'switch', and 'while'
sp_after_sparen               = ignore   # ignore/add/remove/force
 
# Add or remove space between ')' and '{' of 'if', 'for', 'switch', and 'while'
sp_sparen_brace               = remove   # ignore/add/remove/force
 
# Add or remove space before empty statement ';' on 'if', 'for' and 'while'
sp_special_semi               = force   # ignore/add/remove/force
 
# Add or remove space before ';'
sp_before_semi                = remove   # ignore/add/remove/force
 
# Add or remove space before ';' in 'for' statements
sp_before_semi_for            = remove   # ignore/add/remove/force
 
# Add or remove space before a semicolon of an empty part of a for statment.
sp_before_semi_for_empty      = ignore   # ignore/add/remove/force
 
 
# Add or remove space before '[' (except '[]')
sp_before_square              = ignore   # ignore/add/remove/force
 
# Add or remove space before '[]'
sp_before_squares             = ignore   # ignore/add/remove/force
 
# Add or remove space inside '[' and ']'
sp_inside_square              = ignore   # ignore/add/remove/force
 
# Add or remove space after ','
sp_after_comma                = force   # ignore/add/remove/force
 
# Add or remove space before ','
sp_before_comma               = remove   # ignore/add/remove/force
 
# Add or remove space between 'operator' and operator sign
sp_after_operator             = ignore   # ignore/add/remove/force
 
# Add or remove space after cast
sp_after_cast                 = ignore   # ignore/add/remove/force
 
# Add or remove spaces inside cast parens
sp_inside_paren_cast          = ignore   # ignore/add/remove/force
 
# Add or remove space between 'sizeof' and '('
sp_sizeof_paren               = ignore   # ignore/add/remove/force
 
# Add or remove space after the tag keyword (Pawn)
sp_after_tag                  = ignore   # ignore/add/remove/force
 
# Add or remove space inside enum '{' and '}'
sp_inside_braces_enum         = ignore   # ignore/add/remove/force
 
# Add or remove space inside struct/union '{' and '}'
sp_inside_braces_struct       = ignore   # ignore/add/remove/force
 
# Add or remove space inside '{' and '}'
sp_inside_braces              = ignore   # ignore/add/remove/force
 
# Add or remove space inside '<' and '>'
sp_inside_angle               = ignore   # ignore/add/remove/force
 
# Add or remove space between return type and function name
# A minimum of 1 is forced except for pointer return types.
sp_type_func                  = ignore   # ignore/add/remove/force
 
# Add or remove space between function name and '(' on function declaration
sp_func_proto_paren           = ignore   # ignore/add/remove/force
 
# Add or remove space between function name and '(' on function definition
sp_func_def_paren             = ignore   # ignore/add/remove/force
 
# Add or remove space inside empty function '()'
sp_inside_fparens             = ignore   # ignore/add/remove/force
 
# Add or remove space inside function '(' and ')'
sp_inside_fparen              = ignore   # ignore/add/remove/force
 
# Add or remove space between ']' and '(' when part of a function call.
sp_square_fparen              = ignore   # ignore/add/remove/force
 
# Add or remove space between ')' and '{' of function
sp_fparen_brace               = ignore   # ignore/add/remove/force
 
# Add or remove space between function name and '(' on function calls
sp_func_call_paren            = ignore   # ignore/add/remove/force
 
# Add or remove space between a constructor/destructor and the open paren
sp_func_class_paren           = ignore   # ignore/add/remove/force
 
# Add or remove space between 'return' and '('
sp_return_paren               = force   # ignore/add/remove/force
 
# Add or remove space between macro and value
sp_macro                      = force   # ignore/add/remove/force
 
# Add or remove space between macro function ')' and value
sp_macro_func                 = force   # ignore/add/remove/force
 
# Add or remove space between 'else' and '{' if on the same line
sp_else_brace                 = force   # ignore/add/remove/force
 
# Add or remove space between '}' and 'else' if on the same line
sp_brace_else                 = force   # ignore/add/remove/force
 
# Add or remove space between 'catch' and '{' if on the same line
sp_catch_brace                = force   # ignore/add/remove/force
 
# Add or remove space between '}' and 'catch' if on the same line
sp_brace_catch                = force   # ignore/add/remove/force
 
# Add or remove space between 'finally' and '{' if on the same line
sp_finally_brace              = force   # ignore/add/remove/force
 
# Add or remove space between '}' and 'finally' if on the same line
sp_brace_finally              = force   # ignore/add/remove/force
 
# Add or remove space between 'try' and '{' if on the same line
sp_try_brace                  = force   # ignore/add/remove/force
 
# Add or remove space between get/set and '{' if on the same line
sp_getset_brace               = force   # ignore/add/remove/force
 
#
# Code alignment (not left column spaces/tabs)
#
 
# Whether to keep non-indenting tabs
align_keep_tabs               = false    # false/true
 
# Whether to use tabs for alinging
align_with_tabs               = true    # false/true
 
# Whether to bump out to the next tab when aligning
align_on_tabstop              = false    # false/true
 
# Whether to right-align numbers.
align_number_right             = false    # false/true
 
# Align variable definitions in prototypes and functions
align_func_params             = true    # false/true
 
# The span for aligning variable definitions (0=don't align)
align_var_def_span            = 0        # number
 
# How to align the star in variable definitions.
#  0=Part of the type
#  1=Part of the variable
#  2=Dangling
align_var_def_star_style      = 0        # number
 
# The threshold for aligning variable definitions (0=no limit)
align_var_def_thresh          = 0        # number
 
# Whether to align the colon in struct bit fields
align_var_def_colon           = true    # false/true
 
# Whether to align inline struct/enum/union variable definitions
align_var_def_inline          = true    # false/true
 
# The span for aligning on '=' in assignments (0=don't align)
align_assign_span             = 1        # number
 
# The threshold for aligning on '=' in assignments (0=no limit)
align_assign_thresh           = 1        # number
 
# The span for aligning on '=' in enums (0=don't align)
align_enum_equ_span           = 1        # number
 
# The threshold for aligning on '=' in enums (0=no limit)
align_enum_equ_thresh         = 1        # number
 
# The span for aligning struct/union (0=don't align)
align_var_struct_span         = 1        # number
 
# The span for aligning struct initializer values (0=don't align)
align_struct_init_span        = 1        # number
 
# The minimum space between the type and the synonym of a typedef
align_typedef_gap             = 1        # number
 
# The span for aligning single-line typedefs (0=don't align)
align_typedef_span            = 1        # number
 
# Controls the positioning of the '*' in typedefs. Just try it.
# 0: Align on typdef type, ignore '*'
# 1: The '*' is part of type name: typedef int  *pint;
# 2: The '*' is part of the type, but dangling: typedef int *pint;
align_typedef_star_style      = 0        # number
 
# The span for aligning comments that end lines (0=don't align)
align_right_cmt_span          = 0        # number
 
# The span for aligning function prototypes (0=don't align)
align_func_proto_span         = 0        # number
 
# Whether to align macros wrapped with a backslash and a newline
align_nl_cont                 = false    # false/true
 
# The minimum space between label and value of a preprocessor define
align_pp_define_gap           = 0        # number
 
# The span for aligning on '#define' bodies (0=don't align)
align_pp_define_span          = 0        # number
 
#
# Newline adding and removing options
#
 
# Try to limit code width to N number of columns
code_width                    = 100        # number
 
# Whether to collapse empty blocks between '{' and '}'
nl_collapse_empty_body        = true    # false/true
 
# Don't touch one-line braced assignments - 'foo_t f = { 1, 2 };'
nl_assign_leave_one_liners    = false    # false/true
 
 
# Don't touch one-line function bodies inside a class xx { } body
nl_class_leave_one_liners     = true    # false/true
 
# Add or remove newlines at the start of the file
nl_start_of_file              = remove   # ignore/add/remove/force
 
# The number of newlines at the start of the file (only used if nl_start_of_file is 'add' or 'force'
nl_start_of_file_min          = 0        # number
 
# Add or remove newline at the end of the file
nl_end_of_file                = force   # ignore/add/remove/force
 
# The number of newlines at the end of the file (only used if nl_end_of_file is 'add' or 'force')
nl_end_of_file_min            = 1        # number
 
# Add or remove newline between '=' and '{'
nl_assign_brace               = ignore   # ignore/add/remove/force
 
# The number of newlines after a block of variable definitions
nl_func_var_def_blk           = 1        # number
 
# Add or remove newline between function call and '('
nl_fcall_brace                = force   # ignore/add/remove/force
 
# Add or remove newline between 'enum' and '{'
nl_enum_brace                 = force   # ignore/add/remove/force
 
# Add or remove newline between 'struct and '{'
nl_struct_brace               = force   # ignore/add/remove/force
 
# Add or remove newline between 'union' and '{'
nl_union_brace                = force   # ignore/add/remove/force
 
# Add or remove newline between 'if' and '{'
nl_if_brace                   = force   # ignore/add/remove/force
 
# Add or remove newline between '}' and 'else'
nl_brace_else                 = force   # ignore/add/remove/force
 
# Add or remove newline between 'else if' and '{'
# If set to ignore, nl_if_brace is used instead
nl_elseif_brace               = force   # ignore/add/remove/force
 
# Add or remove newline between 'else' and '{'
nl_else_brace                 = force   # ignore/add/remove/force
 
# Add or remove newline between '}' and 'finally'
nl_brace_finally              = remove   # ignore/add/remove/force
 
# Add or remove newline between 'finally' and '{'
nl_finally_brace              = force   # ignore/add/remove/force
 
# Add or remove newline between 'try' and '{'
nl_try_brace                  = force   # ignore/add/remove/force
 
# Add or remove newline between get/set and '{'
nl_getset_brace               = ignore   # ignore/add/remove/force
 
# Add or remove newline between 'for' and '{'
nl_for_brace                  = force   # ignore/add/remove/force
 
# Add or remove newline between 'catch' and '{'
nl_catch_brace                = remove   # ignore/add/remove/force
 
# Add or remove newline between '}' and 'catch'
nl_brace_catch                = remove   # ignore/add/remove/force
 
# Add or remove newline between 'while' and '{'
nl_while_brace                = force   # ignore/add/remove/force
 
# Add or remove newline between 'do' and '{'
nl_do_brace                   = force   # ignore/add/remove/force
 
# Add or remove newline between '}' and 'while' of 'do' statement
nl_brace_while                = remove   # ignore/add/remove/force
 
# Add or remove newline between 'switch' and '{'
nl_switch_brace               = force   # ignore/add/remove/force
 
# Whether to put a newline before 'case' statement
nl_before_case                = false    # false/true
 
# Whether to put a newline after 'case' statement
nl_after_case                 = true    # false/true
 
# Newline between namespace and {
nl_namespace_brace            = force   # ignore/add/remove/force
 
# Add or remove newline between 'template<>' and 'class'
nl_template_class             = force   # ignore/add/remove/force
 
# Add or remove newline between 'class' and '{'
nl_class_brace                = force   # ignore/add/remove/force
 
# Add or remove newline after each ',' in the constructor member initialization
nl_class_init_args            = remove   # ignore/add/remove/force
 
# Add or remove newline between return type and function name in definition
nl_func_type_name             = remove   # ignore/add/remove/force
 
# Add or remove newline after '(' in a function declaration
nl_func_decl_start            = remove   # ignore/add/remove/force
 
# Add or remove newline after each ',' in a function declaration
nl_func_decl_args             = ignore   # ignore/add/remove/force
 
# Add or remove newline before the ')' in a function declaration
nl_func_decl_end              = remove   # ignore/add/remove/force
 
# Add or remove newline between function signature and '{'
nl_fdef_brace                 = force   # ignore/add/remove/force
 
# Whether to put a newline after 'return' statement
nl_after_return               = false    # false/true
 
# Whether to put a newline after semicolons, except in 'for' statements
nl_after_semicolon            = true    # false/true
 
# Whether to put a newline after brace open
# Note: it will modify code from "char charArray[LEN] = {0}" to "char charArray[LEN] = { \r\n 0}", if nl_after_brace_open=true
nl_after_brace_open           = false    # false/true
 
# Whether to alter newlines in '#define' macros
nl_define_macro               = true    # false/true
 
# Whether to not put blanks after '#ifxx', '#elxx', or before '#endif'
nl_squeeze_ifdef              = true    # false/true
 
# Add or remove newline before 'if'. 
# Note: If you add newline before "if" and there are continue comment lines, Uncrustify may add newline and escape char before comment, it is dangerous
nl_before_if                  = ignore   # ignore/add/remove/force
 
# Add or remove newline after 'if'
nl_after_if                   = force   # ignore/add/remove/force
 
# Add or remove newline before 'for'
nl_before_for                 = ignore   # ignore/add/remove/force
 
# Add or remove newline after 'for'
nl_after_for                  = force   # ignore/add/remove/force
 
# Add or remove newline before 'while'
nl_before_while               = ignore   # ignore/add/remove/force
 
# Add or remove newline after 'while'
nl_after_while                = force   # ignore/add/remove/force
 
# Add or remove newline before 'switch'
nl_before_switch              = ignore   # ignore/add/remove/force
 
# Add or remove newline after 'switch'
nl_after_switch               = force   # ignore/add/remove/force
 
# Add or remove newline before 'do'
nl_before_do                  = ignore   # ignore/add/remove/force
 
# Add or remove newline after 'do'
nl_after_do                   = force   # ignore/add/remove/force
 
# Whether to double-space commented-entries in struct/enum
nl_ds_struct_enum_cmt         = false    # false/true
 
#
# Positioning options
#
 
# The position of boolean operators in wrapped expressions
pos_bool                      = lead   # ignore/lead/trail
 
# The position of the comma in wrapped expressions
pos_comma                     = trail   # ignore/lead/trail
 
# The position of colons between constructor and member initialization
pos_class_colon               = lead   # ignore/lead/trail
 
# Whether to fully split long 'for' statements at semi-colons
# Note: Uncrustify may output wrong code if NO SOLUTION, can't compile
ls_for_split_full             = false    # false/true
 
# Whether to fully split long function protos/calls at commas
ls_func_split_full            = false    # false/true
 
#
# Blank line options
#
 
# The maximum consecutive newlines
nl_max                        = 2        # number
 
# The number of newlines after a function prototype, if followed by another function prototype
nl_after_func_proto           = 0        # number
 
# The number of newlines after a function prototype, if not followed by another function prototype
nl_after_func_proto_group     = 1        # number
 
# The number of newlines after '}' of a multi-line function body
nl_after_func_body            = 2        # number
 
# The number of newlines after '}' of a single line function body
nl_after_func_body_one_liner  = 2        # number
 
# The minimum number of newlines before a multi-line comment.
# Doesn't apply if after a brace open or another multi-line comment.
nl_before_block_comment       = 2       # number
 
# The minimum number of newlines before a single-line C comment.
# Doesn't apply if after a brace open or other single-line C comments.
nl_before_c_comment           = 2        # number
 
# The minimum number of newlines before a CPP comment.
# Doesn't apply if after a brace open or other CPP comments.
nl_before_cpp_comment         = 2        # number
 
# Whether to remove blank lines after '{'
eat_blanks_after_open_brace   = true    # false/true
 
# Whether to remove blank lines before '}'
eat_blanks_before_close_brace = true    # false/true
 
#
# Code modifying options (non-whitespace)
#
 
# Add or remove braces on single-line 'do' statement
mod_full_brace_do             = add   # ignore/add/remove/force
 
# Add or remove braces on single-line 'for' statement
mod_full_brace_for            = add   # ignore/add/remove/force
 
# Add or remove braces on single-line function defintions. (Pawn)
mod_full_brace_function       = ignore   # ignore/add/remove/force
 
# Add or remove braces on single-line 'if' statement
mod_full_brace_if             = add   # ignore/add/remove/force
 
# Don't remove braces around statements that span N newlines
mod_full_brace_nl             = 0        # number
 
# Add or remove braces on single-line 'while' statement
mod_full_brace_while          = add   # ignore/add/remove/force
 
# Add or remove unnecessary paren on 'return' statement
mod_paren_on_return           = ignore   # ignore/add/remove/force
 
# Whether to change optional semicolons to real semicolons
mod_pawn_semicolon            = false    # false/true
 
# Add parens on 'while' and 'if' statement around bools
# Note: Add () on bool expression from: if ( a>0 && b>0 ) to: if ( (a>0) && (b>0) )
# Note: Modified parens.cpp, line 34, add token for elseif, else, while,...etc
mod_full_paren_if_bool        = true    # false/true
 
#
# Comment modifications
#
 
# Whether to group cpp-comments that look like they are in a block
cmt_cpp_group                 = true    # false/true
 
# Whether to put an empty '/*' on the first line of the combined cpp-comment
cmt_cpp_nl_start              = false    # false/true
 
# Whether to put a newline before the closing '*/' of the combined cpp-comment
cmt_cpp_nl_end                = false    # false/true
 
# Whether to change cpp-comments into c-comments
cmt_cpp_to_c                  = false    # false/true
 
# Whether to put a star on subsequent comment lines
cmt_star_cont                 = false    # false/true
 
# The number of spaces to insert at the start of subsequent comment lines
cmt_sp_before_star_cont       = 0        # number
 
# The number of spaces to insert after the star on subsequent comment lines
cmt_sp_after_star_cont        = 0        # number
 
#
# Preprocessor options
#
 
# Add or remove indent of preprocessor directives
pp_indent                     = force   # ignore/add/remove/force
 
# Add or remove space between # and, say, define
pp_space                      = ignore   # ignore/add/remove/force

posted @ 2020-04-13 09:49 iBilllee 阅读(523) 评论(0) 编辑收藏举报

刷新页面返回顶部

iBilllee

[转] 代码格式化工具 uncrustify 配置文件选项详解

通用(general)

缩进(Indent)

空格(Spacing)

对齐(align)

新行添加与移除

位置

行划分

空行

代码修改(非空格)

注释修改

预处理

实例

公告