Zig 惯用法之命名规则

[jiacai2050]

一般来说：

• 函数采用 camelCase
• 类型采用 PascalCase
• 变量采用 lowercase_with_underscores

这样当我们看到是 file_path 就知道这是一个变量， FilePath 是一个类型。

有一个例外的情况，就是返回类型的函数，它们采用 PascalCase ，例如：

pub fn ArrayList(comptime T: type) type {
    return ArrayListAligned(T, null);
}

pub fn StringHashMap(comptime V: type) type {
    return HashMap([]const u8, V, StringContext, default_max_load_percentage);
}

这些函数通常用来实现泛型。

与之类似，文件名通常是 lowercase_with_underscore 风格，但是，如果把文件作为 struct 使用时，那就应该采用 PascalCase 风格，比如

// Foo.zig
pub var a: usize = 1;

b: usize,

const Self = @This();

pub fn inc(self: *Self) void {
    self.b += 1;
}

// main.zig
const Foo = @import("Foo.zig");

pub fn main() !void {
    const foo = Foo{ .b = 100 };
    std.debug.print("Type of Foo is {any}, foo is {any}\n", .{
        @TypeOf(Foo),
        @TypeOf(foo),
    });
    foo.inc();
    std.debug.print("foo.b = {d}\n", .{foo.b});
}

摘抄自：https://github.com/zigcc/zig-idioms