定义项目的编码规范 跨编辑器和IDE编写代码,保持一致的简单编码风格;对程序文件的通用基本格式进行了限制,并不关心某个编程语言自身的语法特性
一、规范编辑器配置
1、常用编码规范
charset: 文件编码。可选值
latin1
utf-8 一般用这个
utf-16be
utf-16le
indent_style: 缩进类型。可选值
space
tab
indent_size: 缩进数量。可选值
整数 一般设置 2 或 4
insert_final_newline: 是否在文件的最后插入一个空行。可选值
true
false
end_of_line: 换行符格式。说明见 Wiki: 换行。可选值
lf 一般用这个
crlf
cr
trim_trailing_whitespace:是否删除行尾的空格。可选值
true
false
2、样例
# Editor configuration, see http://editorconfig.org
# 表示是最顶层的 EditorConfig 配置文件
root = true
# 表示所有文件适用
[*]
# 设置文件字符集为 utf-8
charset = utf-8
# 缩进风格(tab | space)
indent_style = space
# 缩进大小(tab 的个数)
indent_size = 2
# 控制换行类型(lf | cr | crlf)
end_of_line = lf
# 去除行首的任意空白字符
trim_trailing_whitespace = true
# 始终在文件末尾插入一个新行
insert_final_newline = true
# 表示仅 md 文件适用以下规则
[*.md]
trim_trailing_whitespace = false
max_line_length = off