refactor(build): remove verbose comments

- Remove lengthy comment blocks throughout build functions
- Clean up unnecessary blank lines between code sections
- Preserve core documentation in comments where needed

Author: jinzhongjia

build.zig

@@ -7,35 +7,28 @@ const Module = Build.Module;
 const builtin = @import("builtin");
 const current_zig = builtin.zig_version;
 
-// Minimum required Zig version for this project
 const min_zig_string = "0.12.0";
-// NOTE: we should note that when enable tls support we cannot compile with musl
-
-// Compile-time check to ensure the Zig version meets the minimum requirement
+// NOTE: when enable tls support we cannot compile with musl
 comptime {
     const min_zig = std.SemanticVersion.parse(min_zig_string) catch unreachable;
     if (current_zig.order(min_zig) == .lt) {
         @compileError(std.fmt.comptimePrint("Your Zig version v{} does not meet the minimum build requirement of v{}", .{ current_zig, min_zig }));
     }
 }
 
-// Define logger and useful type aliases
 const log = std.log.scoped(.WebUI);
-// Default build configuration options
 const default_isStatic = true;
 const default_enableTLS = false;
 
 pub fn build(b: *Build) !void {
-    // Parse command-line options or use defaults
     const isStatic = b.option(bool, "is_static", "whether lib is static") orelse default_isStatic;
     const enableTLS = b.option(bool, "enable_tls", "whether lib enable tls") orelse default_enableTLS;
     const enableWebUILog = b.option(bool, "enable_webui_log", "whether lib enable tls") orelse default_enableTLS;
 
-    // Standard build options for target and optimization
     const target = b.standardTargetOptions(.{});
     const optimize = b.standardOptimizeOption(.{});
 
-    // TLS support has some limitations
+    // TLS does not support cross compilation
     if (enableTLS) {
         log.info("enable TLS support", .{});
         if (!target.query.isNative()) {
@@ -44,16 +37,9 @@ pub fn build(b: *Build) !void {
         }
     }
 
-    // Create build options that will be used as a module
     const flags_options = b.addOptions();
-
-    // Configure compile-time options
     flags_options.addOption(bool, "enableTLS", enableTLS);
-
-    // Create a module that exposes the options
     const flags_module = flags_options.createModule();
-
-    // Get the webui dependency with appropriate options
     const webui = b.dependency("webui", .{
         .target = target,
         .optimize = optimize,
@@ -62,8 +48,6 @@ pub fn build(b: *Build) !void {
         .@"enable-webui-log" = enableWebUILog,
         .verbose = .err,
     });
-
-    // Create the webui module that applications can import
     const webui_module = b.addModule("webui", .{
         .root_source_file = b.path(b.pathJoin(&.{ "src", "webui.zig" })),
         .imports = &.{
@@ -73,31 +57,23 @@ pub fn build(b: *Build) !void {
             },
         },
     });
-    // Link against the webui library
     webui_module.linkLibrary(webui.artifact("webui"));
     if (!isStatic) {
-        // For dynamic libraries, install the shared library
         b.installArtifact(webui.artifact("webui"));
     }
 
-    // Setup documentation generation
     generateDocs(b, optimize, target, flags_module);
 
-    // Create compatibility module for Zig version differences
     const compat_module = b.addModule("compat", .{
         .root_source_file = b.path(b.pathJoin(&.{ "examples", "compat.zig" })),
     });
-
-    // Build example applications
     buildExamples(b, optimize, target, webui_module, compat_module, webui.artifact("webui")) catch |err| {
         log.err("failed to build examples: {}", .{err});
         std.process.exit(1);
     };
 }
 
-// Function to generate API documentation
 fn generateDocs(b: *Build, optimize: OptimizeMode, target: Build.ResolvedTarget, flags_module: *Module) void {
-    // Create a temporary object for documentation generation
     const webui_lib = b.addObject(if (builtin.zig_version.minor == 14) .{
         .name = "webui_lib",
         .root_source_file = b.path(b.pathJoin(&.{ "src", "webui.zig" })),
@@ -114,10 +90,7 @@ fn generateDocs(b: *Build, optimize: OptimizeMode, target: Build.ResolvedTarget,
 
     webui_lib.root_module.addImport("flags", flags_module);
 
-    // Create a build step for documentation
     const docs_step = b.step("docs", "Generate docs");
-
-    // Setup documentation installation
     const docs_install = b.addInstallDirectory(.{
         .source_dir = webui_lib.getEmittedDocs(),
         .install_dir = .prefix,
@@ -127,18 +100,10 @@ fn generateDocs(b: *Build, optimize: OptimizeMode, target: Build.ResolvedTarget,
     docs_step.dependOn(&docs_install.step);
 }
 
-// Function to build all example applications
 fn buildExamples(b: *Build, optimize: OptimizeMode, target: Build.ResolvedTarget, webui_module: *Module, compat_module: *Module, webui_lib: *Compile) !void {
-
-    // Get the absolute path to the examples directory
     var lazy_path = b.path("examples");
-
-    // Create a step to build all examples
     const build_all_step = b.step("examples", "build all examples");
-
     const examples_path = lazy_path.getPath(b);
-
-    // Open the examples directory for iteration
     var iter_dir = std.fs.openDirAbsolute(
         examples_path,
         .{ .iterate = true },
@@ -152,16 +117,13 @@ fn buildExamples(b: *Build, optimize: OptimizeMode, target: Build.ResolvedTarget
 
     var itera = iter_dir.iterate();
 
-    // Iterate through all subdirectories in the examples directory
     while (try itera.next()) |val| {
         if (val.kind != .directory) {
             continue;
         }
 
         const example_name = val.name;
         const path = b.pathJoin(&.{ "examples", example_name, "main.zig" });
-
-        // Create an executable for each example
         const exe = b.addExecutable(if (builtin.zig_version.minor == 14) .{
             .name = example_name,
             .root_source_file = b.path(path),
@@ -176,25 +138,18 @@ fn buildExamples(b: *Build, optimize: OptimizeMode, target: Build.ResolvedTarget
             }),
         });
 
-        // Add the webui and compat modules and link against the library
         exe.root_module.addImport("webui", webui_module);
         exe.root_module.addImport("compat", compat_module);
         exe.linkLibrary(webui_lib);
 
-        // Setup installation
         const exe_install = b.addInstallArtifact(exe, .{});
-
         build_all_step.dependOn(&exe_install.step);
 
-        // Create a run step for the example
         const exe_run = b.addRunArtifact(exe);
         exe_run.step.dependOn(&exe_install.step);
 
-        // Set the working directory for the run
         const cwd = b.path(b.pathJoin(&.{ "examples", example_name }));
         exe_run.setCwd(cwd);
-
-        // Create a named step to run this specific example
         const step_name = try std.fmt.allocPrint(b.allocator, "run_{s}", .{example_name});
         const step_desc = try std.fmt.allocPrint(b.allocator, "run_{s}", .{example_name});