风格指南 (Style Guide)

Zig 官方提供了一套风格指南,旨在保持代码库的一致性和可读性。zig fmt 工具可以自动格式化代码以符合这些规则。

缩进

使用 4 个空格进行缩进。不要使用 Tab。

命名规范

  • 函数 (Functions): camelCase(驼峰式),例如 parseInt
  • 变量 (Variables): snake_case(蛇形),例如 buffer_size
  • 类型 (Types): PascalCase(帕斯卡式),例如 ArrayList
  • 文件 (Files): snake_case,例如 main.zig, http_client.zig

括号

左大括号 { 不换行。

fn add(a: i32, b: i32) i32 {
    return a + b;
}

导入顺序

@import 语句通常放在文件顶部。std 库通常最先导入。

const std = @import("std");
const builtin = @import("builtin");
const MyType = @import("my_type.zig");

冗余

避免冗余的代码。例如,如果可以通过上下文推断出类型,则可以使用匿名列表字面量 .{ ... }

另请参阅: