評価2: 開発環境のセットアップと基本操作 - 評価基準

評価の目的

この評価では、学生がZig開発環境を正しくセットアップし、基本的なビルドツール、コンパイラオプション、ファイルI/Oなどの実践的なスキルを習得しているかを確認します。開発環境の適切な構築は、効率的な開発の基盤となります。

学習目標

• Zigツールチェーンのインストールと動作確認ができる
• 基本的なZigコマンド（run、build-exe、test）を使用できる
• コマンドライン引数を処理できる
• ファイルの読み書きとエラー処理を実装できる
• build.zigを作成し、プロジェクト構造を理解できる
• クロスコンパイルの概念と実践ができる
• 最適化オプションの違いを理解し、活用できる

評価項目

1. インストールと環境確認（15点）

評価のポイント:

• Zig 0.11.0以上が推奨（2023年以降の機能サポート）
• 主要コマンドの理解：run, build-exe, build, test, fmt, cc
• ターゲットプラットフォームの多様性の認識

2. Hello Worldプログラム（20点）

実装チェックポイント:

const std = @import("std");

pub fn main() void {
    std.debug.print("Hello, Zig!\n", .{});
}

• const std = @import("std"); の正しい使用
• pub fn main() の適切な定義
• std.debug.print のフォーマット指定子理解

3. コマンドライン引数処理（25点）

評価ポイント:

• argsAllocとargsFreeのペア使用
• args[0]がプログラム名であることの理解
• 引数の反復処理（for文またはwhile文）
• フォーマット指定子の適切な使用

4. ファイル入出力（40点）

実装チェックポイント:

writeFile関数:

pub fn writeFile(filename: []const u8, content: []const u8) !void {
    const file = try std.fs.cwd().createFile(filename, .{});
    defer file.close();
    try file.writeAll(content);
}

readFile関数:

pub fn readFile(allocator: std.mem.Allocator, filename: []const u8) ![]u8 {
    const file = try std.fs.cwd().openFile(filename, .{});
    defer file.close();
    const content = try file.readToEndAlloc(allocator, 1024 * 1024);
    return content;
}

ボーナス課題の評価

Bonus 1: build.zigの作成（15点）

評価チェックポイント:

• std.Buildの正しい使用
• 実行ファイルの定義（addExecutable）
• モジュールの追加（addModule）
• runステップの実装
• testステップの実装
• 適切なプロジェクト構造

標準的なbuild.zig例:

const std = @import("std");

pub fn build(b: *std.Build) void {
    const target = b.standardTargetOptions(.{});
    const optimize = b.standardOptimizeOption(.{});

    const exe = b.addExecutable(.{
        .name = "myapp",
        .root_source_file = .{ .path = "src/main.zig" },
        .target = target,
        .optimize = optimize,
    });

    b.installArtifact(exe);

    const run_cmd = b.addRunArtifact(exe);
    const run_step = b.step("run", "Run the app");
    run_step.dependOn(&run_cmd.step);

    const tests = b.addTest(.{
        .root_source_file = .{ .path = "src/utils.zig" },
        .target = target,
        .optimize = optimize,
    });

    const test_step = b.step("test", "Run tests");
    test_step.dependOn(&b.addRunArtifact(tests).step);
}

Bonus 2: クロスコンパイル（15点）

評価ポイント:

• -targetオプションの正しい使用
• 異なるアーキテクチャ（x86_64、aarch64）
• 異なるOS（linux、windows、macos）
• バイナリサイズの比較と分析
• 実行可能性の確認（可能な範囲で）

例:

zig build-exe -target x86_64-linux calculator.zig -femit-bin=calculator-linux-x64
zig build-exe -target x86_64-windows calculator.zig -femit-bin=calculator-windows.exe
zig build-exe -target aarch64-linux calculator.zig -femit-bin=calculator-linux-arm64

Bonus 3: ZLS統合とエディタ設定（10点）

評価基準詳細:

• ZLSのバージョン確認（0.10.0以上推奨）
• エディタ設定ファイルの提出
• 以下の機能のスクリーンショット：

Bonus 4: パフォーマンス比較（20点）

評価ポイント:

• 4つの最適化レベル：Debug、ReleaseSafe、ReleaseFast、ReleaseSmall
• 実行時間の正確な測定
• バイナリサイズの記録
• 以下を含む分析：

レポート必須項目:

## ベンチマーク結果

| 最適化レベル | 実行時間 | バイナリサイズ | 特徴 |
|--------------|----------|----------------|------|
| Debug        | XXX ms   | XXX KB         | ... |
| ReleaseSafe  | XXX ms   | XXX KB         | ... |
| ReleaseFast  | XXX ms   | XXX KB         | ... |
| ReleaseSmall | XXX ms   | XXX KB         | ... |

## 分析
...

評価チェックリスト

マンダトリー要件（必須）

• [ ] Zigが正しくインストールされている（zig version出力あり）
• [ ] Part 2のhello.zigがすべての方法で実行できる
• [ ] Part 3のargs.zigが引数を正しく処理する
• [ ] Part 3でメモリリークがない（valgrindまたは目視確認）
• [ ] Part 4のwriteFile関数が動作する
• [ ] Part 4のreadFile関数が動作する
• [ ] Part 4でファイルが正しくクローズされている
• [ ] すべてのコードがコンパイルエラーなく動作する
• [ ] エラー処理が適切に実装されている
• [ ] 提出物のディレクトリ構造が要件を満たす

コード品質

• [ ] 適切なインデントとフォーマット
• [ ] 意味のある変数名
• [ ] 必要な場所にコメント
• [ ] エラーメッセージがわかりやすい
• [ ] deferによるリソース管理
• [ ] try/catchの適切な使用

ボーナス要件

• [ ] Bonus 1: build.zigでビルド・実行・テストが動作
• [ ] Bonus 1: プロジェクト構造が適切
• [ ] Bonus 2: 3つのターゲットでビルド成功
• [ ] Bonus 2: バイナリサイズを比較している
• [ ] Bonus 3: ZLSが動作している（スクリーンショット）
• [ ] Bonus 3: エディタ設定ファイルが適切
• [ ] Bonus 4: 4つの最適化レベルで測定
• [ ] Bonus 4: 詳細な分析レポート

合格基準

最低合格条件

• マンダトリー課題で70点以上
• Part 4のファイルI/Oが正しく動作
• メモリリークやリソースリークがない

学習の手引き

効果的な学習方法

• 段階的なアプローチ

• エラーメッセージの理解

• ドキュメントの活用

• 実験的な学習

よくある間違いと対策

間違い1: メモリリーク

// ❌ 間違い
pub fn main() !void {
    const allocator = std.heap.page_allocator;
    const args = try std.process.argsAlloc(allocator);
    // argsFreeを忘れている
}

// ✅ 正しい
pub fn main() !void {
    const allocator = std.heap.page_allocator;
    const args = try std.process.argsAlloc(allocator);
    defer std.process.argsFree(allocator, args);
}

間違い2: ファイルクローズの忘れ

// ❌ 間違い
pub fn writeFile(filename: []const u8, content: []const u8) !void {
    const file = try std.fs.cwd().createFile(filename, .{});
    try file.writeAll(content);
    // closeを忘れている
}

// ✅ 正しい
pub fn writeFile(filename: []const u8, content: []const u8) !void {
    const file = try std.fs.cwd().createFile(filename, .{});
    defer file.close();
    try file.writeAll(content);
}

間違い3: エラー処理の省略

// ❌ 間違い
const file = std.fs.cwd().openFile("test.txt", .{});
// tryがない

// ✅ 正しい
const file = try std.fs.cwd().openFile("test.txt", .{});
defer file.close();

間違い4: 最大ファイルサイズの未指定

// ❌ 問題あり
const content = try file.readToEndAlloc(allocator, std.math.maxInt(usize));
// メモリを無制限に確保しようとする

// ✅ 正しい
const content = try file.readToEndAlloc(allocator, 1024 * 1024); // 1MB制限
defer allocator.free(content);

デバッグのヒント

• コンパイルエラーのデバッグ

• 実行時エラーのデバッグ

• メモリリークのデバッグ

• パフォーマンスのデバッグ

環境別セットアップガイド

Linux

# Zigのインストール
wget https://ziglang.org/download/0.11.0/zig-linux-x86_64-0.11.0.tar.xz
tar xf zig-linux-x86_64-0.11.0.tar.xz
sudo mv zig-linux-x86_64-0.11.0 /usr/local/zig
export PATH=$PATH:/usr/local/zig

# ZLSのインストール
wget https://github.com/zigtools/zls/releases/download/0.11.0/zls-linux-x86_64-0.11.0.tar.xz
tar xf zls-linux-x86_64-0.11.0.tar.xz
sudo mv zls /usr/local/bin/

macOS

# Homebrewを使用
brew install zig zls

# または手動インストール
# https://ziglang.org/download/ からダウンロード

Windows

# Scoopを使用
scoop install zig zls

# または手動インストール
# https://ziglang.org/download/ からダウンロードしてPATHに追加

推奨エディタ設定

VS Code

• Zig Language (ziglang.vscode-zig)

settings.json:

{
  "zig.path": "/usr/local/bin/zig",
  "zig.zls.path": "/usr/local/bin/zls",
  "zig.initialSetupDone": true,
  "editor.formatOnSave": true,
  "zig.formattingProvider": "zls"
}

Neovim

require'lspconfig'.zls.setup{
  cmd = {'/usr/local/bin/zls'},
  filetypes = {'zig'},
  root_dir = require'lspconfig'.util.root_pattern('.git', 'build.zig'),
}

Emacs

(use-package zig-mode
  :ensure t
  :config
  (add-hook 'zig-mode-hook #'lsp))

時間配分の目安

合計: マンダトリーで6.5-10時間、ボーナス込みで12.5-20時間

評価後のフィードバック例

優秀な提出物の場合

素晴らしい環境構築とコード実装です。特にファイルI/Oの実装は
非常に丁寧で、エラー処理とリソース管理が適切に行われています。
build.zigの実装も標準的な構造に従っており、プロジェクト管理の
理解が優れています。

クロスコンパイルのバイナリサイズ比較とパフォーマンスベンチマークの
分析は非常に詳細で、最適化の影響を深く理解していることが分かります。

次のステップ: カスタムアロケータの実装や、より複雑なビルドシステムの
構築に挑戦することをお勧めします。

改善が必要な場合

基本的な実装はできていますが、以下の点で改善が必要です:

1. ファイルI/Oでdeferを使用していないため、エラー時にファイルが
   クローズされない可能性があります。
2. コマンドライン引数のメモリ解放が行われていません。
3. エラーメッセージがユーザーフレンドリーでありません。

改善のヒント:
- すべてのリソース確保の直後にdeferを追加
- エラー型を適切に処理（try/catch）
- std.debug.printでわかりやすいメッセージを表示

参考: 公式ドキュメントのFile Systemセクションを復習してください。

参考資料

• Zig公式ドキュメント: https://ziglang.org/documentation/master/
• Zig Standard Library - fs: https://ziglang.org/documentation/master/std/#std.fs
• Zig Standard Library - process: https://ziglang.org/documentation/master/std/#std.process
• Zig Build System: https://ziglang.org/documentation/master/#Build-System
• ZLS GitHub: https://github.com/zigtools/zls
• Zig Learn - Chapter 2: https://ziglearn.org/chapter-2/