能否编写Git pre-commit钩子限制.NET代码中每个方法仅15行代码？

当然可以做到！比起单纯限制文件行数，针对方法级别的行数限制其实更能倒逼大家写出更模块化、可读性更强的代码。下面我就一步步教你实现这个钩子，核心是用.NET自家的Roslyn编译器平台来精准解析C#代码，统计每个方法的有效代码行数，在提交前把不符合规则的代码拦下来。

1. 编写C#代码分析工具（基于Roslyn） #

要准确识别方法并统计行数，直接用正则表达式很容易出错，Roslyn作为.NET的官方编译器平台，能完美解析C#的语法结构，是最佳选择。

首先创建一个控制台项目（比如叫MethodLineCounter），然后通过NuGet安装两个包：Microsoft.CodeAnalysis.CSharp和Microsoft.CodeAnalysis。

然后写入以下代码：

using System;
using System.IO;
using System.Linq;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;

namespace MethodLineCounter
{
    class Program
    {
        static int Main(string[] args)
        {
            if (args.Length == 0)
            {
                Console.WriteLine("请传入要检查的C#文件路径");
                return 1;
            }

            bool hasRuleBreaches = false;
            const int MaxAllowedLines = 15;

            foreach (var filePath in args)
            {
                if (!File.Exists(filePath) || Path.GetExtension(filePath) != ".cs")
                    continue;

                var codeContent = File.ReadAllText(filePath);
                var syntaxTree = CSharpSyntaxTree.ParseText(codeContent);
                var rootNode = syntaxTree.GetRoot();

                // 捕获所有方法：包括普通方法、异步方法、局部方法
                var allMethods = rootNode.DescendantNodes().OfType<MethodDeclarationSyntax>()
                    .Concat(rootNode.DescendantNodes().OfType<LocalFunctionStatementSyntax>());

                foreach (var method in allMethods)
                {
                    var methodBody = method.Body;
                    if (methodBody == null) continue; // 跳过抽象方法、接口方法这类无实现的方法

                    // 获取方法体的起止行号（注意Roslyn的行号从0开始，要转成日常的1起始）
                    var startLine = syntaxTree.GetLineSpan(methodBody.SpanStart).StartLinePosition.Line + 1;
                    var endLine = syntaxTree.GetLineSpan(methodBody.SpanEnd).EndLinePosition.Line + 1;
                    var totalRawLines = endLine - startLine - 1; // 减去首尾大括号所在的行

                    // 过滤空行和仅含大括号/空格的行，只统计有效代码行
                    var methodLines = File.ReadAllLines(filePath).Skip(startLine).Take(totalRawLines);
                    var effectiveLineCount = methodLines.Count(line => 
                        !string.IsNullOrWhiteSpace(line) && !line.Trim().Equals("{"));

                    if (effectiveLineCount > MaxAllowedLines)
                    {
                        Console.WriteLine($"❌ 文件 {filePath} 中的方法 {method.Identifier.Text} 有效代码行数为 {effectiveLineCount}，超过限制的 {MaxAllowedLines} 行");
                        hasRuleBreaches = true;
                    }
                }
            }

            // 有违规返回1（阻止提交），无违规返回0（允许提交）
            return hasRuleBreaches ? 1 : 0;
        }
    }
}

2. 编译工具并放置到合适位置 #

编译这个控制台项目，生成MethodLineCounter.exe，把它放到项目的.git/hooks/tools/目录下（如果没有这个目录就手动创建）。

3. 编写Git pre-commit钩子脚本 #

Git钩子文件放在项目的.git/hooks/目录下，我们需要创建一个名为pre-commit的无后缀文件，根据系统选择对应的脚本：

Windows版本（批处理脚本） #

@echo off

:: 获取本次提交中新增/修改的所有.cs文件
for /f "tokens=*" %%f in ('git diff --cached --name-only --diff-filter=ACM *.cs') do (
    .git/hooks/tools/MethodLineCounter.exe "%%f"
)

:: 检查工具返回值，非0则终止提交
if %errorlevel% neq 0 (
    echo "❌ 存在方法代码行数超标的情况，提交已终止，请优化代码后重试"
    exit /b 1
)

exit /b 0

Linux/macOS版本（Bash脚本） #

#!/bin/bash

# 获取本次提交中新增/修改的所有.cs文件
TARGET_FILES=$(git diff --cached --name-only --diff-filter=ACM *.cs)

# 遍历文件并调用分析工具
for FILE in $TARGET_FILES; do
    .git/hooks/tools/MethodLineCounter "$FILE"
done

# 检查返回结果，有违规则阻止提交
if [ $? -ne 0 ]; then
    echo "❌ 存在方法代码行数超标的情况，提交已终止，请优化代码后重试"
    exit 1
fi

exit 0

注意：Linux/macOS下需要给脚本添加可执行权限，执行命令：chmod +x .git/hooks/pre-commit

4. 测试钩子功能 #

现在尝试提交一个包含超过15行有效代码的方法，钩子会自动检测到违规，输出提示信息并终止提交；只有当所有方法都符合行数限制时，提交才能正常完成。

可选扩展 #

• 可以添加特性标记（比如[AllowLongMethod]），让工具跳过特定方法的检查
• 调整MaxAllowedLines的值可以修改行数限制
• 可以忽略自动生成的代码文件（比如*.Designer.cs），在遍历文件时添加过滤逻辑

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