Akademi C# · Pelajaran

Ergonomik CLI

Bina alat baris perintah yang mesra: bantuan yang jelas, bendera ringkas, kod keluar, stdout berbanding stderr, penghuraian asas dan perincian output yang mudah.

Pelajaran 3 daripada 38 langkah

Ergonomik CLI ialah pelajaran Akademi C# percuma di CoddyKit. Ini ialah pelajaran 3 daripada 3. Anda boleh membaca keseluruhan pelajaran di bawah secara percuma — kemudian berlatih secara praktikal dalam pelayar menggunakan penyunting kod terbina dalam dan tutor kecerdasan buatan 24/7. Pelajaran ini merupakan sebahagian daripada laluan pembelajaran Akademi C#, dan kemajuan anda disegerakkan merentas web serta aplikasi CoddyKit. Kursus Akademi C# merangkumi sejumlah 3 pelajaran.

Asas CLI mesra pengguna

Matlamat:

  • Paparkan bantuan dengan -h/--help
  • Gunakan pilihan yang jelas (-i, -o, --verbose)
  • Kembalikan 0 apabila berjaya, dan nilai bukan sifar apabila berlaku ralat
  • Hantar hasil kepada stdout, dan diagnostik kepada stderr

Penggunaan dan bantuan

Tambahkan bahagian penggunaan yang pendek dan terima pilihan pendek serta panjang; paparkannya apabila masukan tiada.

using System;

// A tiny CLI that prints help if no args or -h/--help is passed.
public class Program
{
  static void PrintUsage()
  {
    Console.WriteLine("usage: tool -i <input> [-o <output>] [--verbose]");
    Console.WriteLine("options:");
    Console.WriteLine("  -i, --input     input file path (required)");
    Console.WriteLine("  -o, --output    output file path (optional)");
    Console.WriteLine("  -h, --help      show help");
    Console.WriteLine("      --verbose   print extra diagnostics to stderr");
  }

  public static void Main(string[] args)
  {
    if (args.Length == 0 || args[0] == "-h" || args[0] == "--help")
    {
      PrintUsage();
      Environment.ExitCode = 0;
      return;
    }

    Console.WriteLine("OK: arguments received"); // placeholder success
  }
}

Pilihan dan kod keluar

Kembalikan nilai bukan sifar bagi pilihan yang tidak sah; pastikan mesej pendek dan khusus. Cetak kejayaan ke stdout.

using System;

// Minimal manual parsing for beginners (no external libs).
public class Program
{
  static void Error(string msg)
  {
    Console.Error.WriteLine("error: " + msg);
    Environment.ExitCode = 1; // non-zero means failure
  }

  public static void Main(string[] args)
  {
    string input = null;
    string output = null;

    for (int i = 0; i < args.Length; i++)
    {
      string a = args[i];
      if (a == "-i" || a == "--input")
      {
        if (i + 1 >= args.Length) { Error("missing value for " + a); return; }
        input = args[++i];
      }
      else if (a == "-o" || a == "--output")
      {
        if (i + 1 >= args.Length) { Error("missing value for " + a); return; }
        output = args[++i];
      }
      else if (a == "-h" || a == "--help")
      {
        Console.WriteLine("usage: tool -i <input> [-o <output>]");
        return;
      }
      else
      {
        Error("unknown option: " + a);
        return;
      }
    }

    if (input == null) { Error("input is required (-i)"); return; }

    // Success path: write result to stdout
    Console.WriteLine("Processed " + input + (output == null ? "" : (" -> " + output)));
    Environment.ExitCode = 0;
  }
}

Stdout berbanding stderr

Letakkan hasil pada stdout (boleh disalurkan), dan diagnostik pada stderr. Tambahkan pilihan --verbose yang mudah.

using System;

// Show separation of streams: stdout (results) vs stderr (diagnostics).
public class Program
{
  public static void Main(string[] args)
  {
    bool verbose = false;
    for (int i = 0; i < args.Length; i++) if (args[i] == "--verbose") verbose = true;

    if (verbose) Console.Error.WriteLine("info: starting work");
    // pretend to compute a number
    int result = 42;
    // Result goes to stdout so it can be piped:  tool ... > out.txt
    Console.WriteLine(result);

    if (verbose) Console.Error.WriteLine("info: finished work");
    Environment.ExitCode = 0;
  }
}

Konvensyen dan kemasan

  • Terima pilihan pendek dan panjang (-h/--help)
  • Gunakan mesej ralat yang jelas (perkara yang salah + cara membetulkannya)
  • Pastikan keluaran lalai minimum; tambahkan --verbose untuk butiran
  • Gunakan kod keluar yang konsisten (0 berjaya, 1 argumen tidak sah, 2 kegagalan I/O)

Ujian asap dan dokumentasi

  • Cuba pengalihan: command > out.txt dan command 2> err.txt
  • Uji laluan ralat: fail tiada, argumen salah
  • Pastikan teks penggunaan kurang daripada kira-kira 5 baris pada mudah alih
  • Dokumentasikan contoh: mudah disalin dan ditampal

Strim dan kod keluar

Semakan pantas: Amalan manakah yang meningkatkan kebolehgunaan CLI dan penyaluran dalam shell?

Imbas kembali

Imbas kembali: Bantuan melalui -h/--help, pilihan yang jelas, kod keluar yang betul, serta pemisahan stdout/stderr menjadikan alat anda mesra skrip dan mudah dijangka.

Percuma untuk bermula

Pelajari C# dengan tutor kecerdasan buatan — percuma

Tulis dan jalankan kod sebenar dalam pelayar anda, dapatkan bantuan segera daripada tutor kecerdasan buatan yang tersedia 24/7, dan sambung semula dari tempat anda berhenti di web atau dalam aplikasi.

Kursus
93
Pelajaran
346

Soalan Lazim

Adakah pelajaran “Ergonomik CLI” percuma?

Ya — teks penuh “Ergonomik CLI” boleh dibaca secara percuma di web ini. Untuk berlatih secara interaktif menggunakan penyunting kod terbina dalam dan tutor kecerdasan buatan 24/7, serta membuka kunci baki kursus Akademi C#, tingkat taraf kepada CoddyKit PRO. Kursus Akademi C# merangkumi sejumlah 3 pelajaran.

Apakah yang akan saya pelajari dalam “Ergonomik CLI”?

Bina alat baris perintah yang mesra: bantuan yang jelas, bendera ringkas, kod keluar, stdout berbanding stderr, penghuraian asas dan perincian output yang mudah. Anda berlatih Akademi C# menggunakan kod praktikal yang dijalankan terus dalam pelayar, manakala tutor kecerdasan buatan 24/7 menjawab soalan anda semasa anda mengikuti pelajaran.

Adakah saya memerlukan pengalaman untuk memulakan Akademi C#?

Tiada pengalaman terdahulu diperlukan. Pembelajaran Akademi C# di CoddyKit disusun untuk pelajar daripada peringkat pemula hingga lanjutan, jadi anda boleh bermula di sini atau dari awal dan belajar mengikut kadar anda sendiri. Ini ialah pelajaran 3 daripada 3.

Berapa lamakah pelajaran “Ergonomik CLI” diambil?

Kebanyakan pelajaran CoddyKit mengambil masa kira-kira 5–10 minit. Setiap pelajaran ringkas dan interaktif, jadi anda boleh membuat kemajuan secara berterusan dan menyambung tepat dari tempat anda berhenti di web atau aplikasi.

Bolehkah saya menulis dan menjalankan kod dalam pelajaran Akademi C# ini?

Ya. Setiap pelajaran Akademi C# menyertakan penyunting kod terbina dalam, jadi anda boleh menulis dan menjalankan kod sebenar terus dalam pelayar serta menerima maklum balas kecerdasan buatan serta-merta — tanpa memerlukan persediaan setempat.

Semua pelajaran dalam kursus ini

  1. Penskripan C# (dotnet script), coretan & REPL
  2. Asas kesalingoperasian (P/Invoke) sepintas lalu
  3. Ergonomik CLI
← Kembali ke Akademi C#