From 67a82861b5644bba4a3b9c0ef6a948d6f572ed46 Mon Sep 17 00:00:00 2001
From: git <git@runjs.cn>
Date: Mon, 26 Jan 2026 11:04:04 +0000
Subject: [PATCH] Add documentation comments for Assembly.zig functions

---
 src/backend/Assembly.zig | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/src/backend/Assembly.zig b/src/backend/Assembly.zig
index 914bffb..65b7ffb 100644
--- a/src/backend/Assembly.zig
+++ b/src/backend/Assembly.zig
@@ -6,11 +6,31 @@ text: []const u8,
 
 const Assembly = @This();
 
+/// 释放 Assembly 结构体分配的内存资源
+///
+/// 此函数释放 Assembly 实例中 data 和 text 字段所占用的内存。
+/// 调用此函数后，Assembly 实例将不再持有有效的内存引用。
+///
+/// Parameters:
+///   - self: 指向 Assembly 实例的常量指针
+///   - gpa: 通用内存分配器，用于释放内存
 pub fn deinit(self: *const Assembly, gpa: Allocator) void {
     gpa.free(self.data);
     gpa.free(self.text);
 }
 
+/// 将程序集数据写入文件
+///
+/// 此函数使用 scatter-gather I/O 方式将 Assembly 的 data 和 text 字段
+/// 连续写入到指定的文件中。data 字段内容先于 text 字段写入。
+///
+/// Parameters:
+///   - self: Assembly 实例（按值传递）
+///   - file: 目标文件句柄
+///
+/// Returns:
+///   - void: 写入成功
+///   - error: 文件写入相关错误
 pub fn writeToAllFile(self: Assembly, file: std.fs.File) !void {
     var vec: [2]std.posix.iovec_const = .{
         .{ .base = self.data.ptr, .len = self.data.len },
-- 
Gitee