From c03d2924ca4070535ab9c984d5fc9acfcf9b85a4 Mon Sep 17 00:00:00 2001
From: git <git@23271.runjs.cn>
Date: Fri, 30 Jan 2026 06:33:18 +0000
Subject: [PATCH] =?UTF-8?q?docs:=20=E4=B8=BA=20Assembly.zig=20=E6=B7=BB?=
 =?UTF-8?q?=E5=8A=A0=E6=96=87=E6=A1=A3=E6=B3=A8=E9=87=8A?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- 为 deinit 函数添加了释放内存的文档说明
- 为 writeToAllFile 函数添加了写入文件的文档说明
---
 src/backend/Assembly.zig | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/backend/Assembly.zig b/src/backend/Assembly.zig
index 914bffb..d9ecb15 100644
--- a/src/backend/Assembly.zig
+++ b/src/backend/Assembly.zig
@@ -6,11 +6,20 @@ text: []const u8,
 
 const Assembly = @This();
 
+/// 释放 Assembly 对象持有的内存
+/// 使用提供的内存分配器释放 data 和 text 字段占用的内存
 pub fn deinit(self: *const Assembly, gpa: Allocator) void {
     gpa.free(self.data);
     gpa.free(self.text);
 }
 
+/// 将程序集数据写入文件
+/// 将 data 和 text 字段的内容按顺序写入指定的文件
+/// 参数:
+///   self: Assembly 实例，包含要写入的 data 和 text 数据
+///   file: 目标文件句柄
+/// 返回:
+///   !void: 写入成功或返回错误
 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