在Visual Studio 2022中配置自定义团队代码样式方案

核心配置文件（.editorconfig） #

将以下内容放在仓库根目录，所有子项目会自动继承配置：

# 标记为根配置，停止向上查找上级配置
root = true

# 通用文件格式基础配置
[*]
indent_style = space       # 使用空格缩进
indent_size = 4            # 缩进大小为4个空格
end_of_line = crlf         # 适配Windows行尾格式（Linux/macOS可改为lf）
charset = utf-8            # 统一文件编码
trim_trailing_whitespace = true  # 自动移除行尾多余空格
insert_final_newline = true      # 文件末尾强制添加空行

# .NET/C# 专属代码样式配置（其他语言替换为对应后缀，如[*.java]/[*.js]）
[*.cs]
# 1. 强制赋值运算符=前后加空格，违反时触发警告
dotnet_style_space_around_assignment_operator = require : warning

# 2. 强制函数参数/列表逗号后加空格，违反时触发警告
dotnet_style_space_after_comma = require : warning

# 3. 缩进规范强化配置
indent_style = space
indent_size = 4
dotnet_style_indentation_in_list = require : warning  # 列表项统一缩进规则

# 开启编译时代码样式检查（可根据需求将warning改为error，强制阻断构建）
dotnet_diagnostic.IDE0055.severity = warning  # 移除不必要的格式问题
dotnet_diagnostic.IDE0017.severity = warning  # 简化对象初始化样式

构建阶段自动检查与修复 #

在项目的.csproj文件中添加以下配置，实现编译时强制校验代码样式，不符合规范的代码会抛出警告/错误：

<PropertyGroup>
  <!-- 开启编译时代码样式检查 -->
  <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
  <!-- 启用官方.NET代码分析器 -->
  <EnableNETAnalyzers>true</EnableNETAnalyzers>
  <!-- 使用最新代码分析规则 -->
  <AnalysisLevel>latest</AnalysisLevel>
</PropertyGroup>

若需要构建时自动修复样式问题，可在项目的预生成事件中添加命令：

dotnet format --no-restore --verbosity minimal

推送代码前的拦截检查 #

配合Git的pre-commit钩子，在代码提交前自动校验样式：

1. 在仓库的.git/hooks目录下创建pre-commit文件
2. 写入以下内容：

#!/bin/sh
# 检查代码样式是否符合规范
dotnet format --check
if [ $? -ne 0 ]; then
    echo "代码样式不符合团队规范，请先修复后再提交"
    exit 1
fi

3. 给文件添加执行权限：chmod +x .git/hooks/pre-commit

IDE实时提示与自动格式化 #

Visual Studio会自动识别.editorconfig文件，编写代码时实时提示违规问题，还可开启保存时自动格式化：

• 打开Visual Studio设置 → 文本编辑器 → 高级 → 勾选"保存时格式化文档"

内容的提问来源于stack exchange，提问作者Srikrishna Sharma