代码编辑器代码格式化完全指南

代码格式化概述

代码格式化是保持代码一致性和可读性的关键功能。自动格式化可以将代码转换为统一的风格，减少手动调整缩进、空格的时间，让开发者专注于业务逻辑。

格式化配置项

代码格式化通常包含以下可配置项：

1. 缩进：使用空格还是 Tab，缩进宽度（2/4/8）

2. 行宽：单行字符数限制（通常 80/100/120）

3. 分号：是否在语句末尾添加分号

4. 引号：单引号还是双引号

5. 花括号：单行语句是否需要花括号

6. 尾随逗号：多行对象/数组是否添加尾随逗号

7. 空格：运算符周围、括号内部是否添加空格

常用格式化工具

各语言有对应的代码格式化工具：

// JavaScript/TypeScript - Prettier
// .prettierrc
{
  "semi": true,
  "singleQuote": true,
  "tabWidth": 2,
  "trailingComma": "es5",
  "printWidth": 100
}

// C/C++ - clang-format
// .clang-format
BasedOnStyle: LLVM
IndentWidth: 4
ColumnLimit: 100
UseTab: Never

// Python - Black
// pyproject.toml
[tool.black]
line-length = 88
target-version = ['py38']
include = '\.pyi?$'

// Go - gofmt
// 常用参数
gofmt -w -s file.go  // 格式化并简化代码
gofmt -d file.go     // 显示格式化差异

编辑器集成

编辑器需要集成格式化工具并提供灵活的触发方式：

// 格式化命令接口
interface Formatter {
    format(document: TextDocument, options: FormatOptions): Promise;
    formatRange(document: TextDocument, range: Range, options: FormatOptions): Promise;
    formatOnType(document: TextDocument, position: Position): Promise;
}

// 格式化触发方式
class FormatManager {
    // 保存时自动格式化
    registerOnSaveHandler(handler) { ... }

    // 输入后自动格式化（trigger character）
    registerOnTypeHandler(handler) { ... }

    // 粘贴时格式化
    registerOnPasteHandler(handler) { ... }

    // 手动触发（Alt+Shift+F）
    formatDocument() { ... }
}

格式化算法

代码格式化的核心是解析和重建：

// 基于 AST 的格式化流程
function format(sourceCode, options) {
    // 1. 解析为 AST
    const ast = parse(sourceCode);

    // 2. 遍历 AST 应用格式化规则
    const formatted = visit(ast, {
        Program(node) {
            return node.body
                .map(n => formatNode(n, options))
                .join('\n');
        },

        FunctionDeclaration(node, context) {
            // 处理函数声明格式
            const indent = getIndent(context.depth);
            return `${indent}${node.kind} ${node.id}() {\n` +
                   formatBody(node.body, context.depth + 1) +
                   `\n${indent}}`;
        }
    });

    return formatted;
}

即时格式化

格式化需要考虑性能，尤其是即时格式化场景：

1. 延迟计算：等待用户暂停输入后触发格式化

2. 增量计算：只格式化当前行或选区

3. 后台处理：格式化在后台线程执行，避免阻塞编辑

4. 预览对比：在应用格式化前显示预览，让用户确认

格式化与版本控制

团队项目中格式化可能带来一些问题：

1. 统一配置：在项目中提交格式化配置文件

2. Git hook：提交前自动运行格式化

3. 差异最小化：配置合理的行宽减少大规模diff

4. CI 检查：在持续集成中检查代码格式