Menambahkan komen biasa dan komen dokumentasi XML

MEvanAW · Nov 24, 2020 · bec5f35 · bec5f35
1 parent 6dcbce0
commit bec5f35
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 10 deletions.
diff --git a/SimulasiAntrianPercetakan/FormAmbilPesanan.cs b/SimulasiAntrianPercetakan/FormAmbilPesanan.cs
@@ -19,11 +19,13 @@ public partial class FormAmbilPesanan : Form
         public FormAmbilPesanan(int idPelanggan)
         {
             InitializeComponent();
+            // Untuk mengenali pelanggan mana yang memesan
             this.idPelanggan = idPelanggan;
+            // Menampilkan nomor pelanggan pada judul form
             Text += idPelanggan.ToString() + ")";
+            // Menampilkan berkas siap ambil
             berkasSiapAmbilLabel.Text = "";
             int noBerkas = 1;
-            // Menampilkan berkas siap ambil
             foreach (Pesanan berkasTercetak in Percetakan.BerkasTercetak)
             {
                 if (berkasTercetak.idPelanggan == idPelanggan)

diff --git a/SimulasiAntrianPercetakan/Pelanggan.cs b/SimulasiAntrianPercetakan/Pelanggan.cs
@@ -8,30 +8,41 @@ namespace SimulasiAntrianPercetakan
 {
     class Pelanggan
     {
-        // Atribut pelanggan
+        // ATRIBUT PELANGGAN
         private int _idPelanggan;
         private List<string> _berkasDimiliki = new List<string>();
 
-        // Constructor pelanggan
+        // KONSTRUKTOR PELANGGAN
         public Pelanggan(int idPelanggan)
         {
             _idPelanggan = idPelanggan;
         }
 
-        // Properties pelanggan
+        // PROPERTIES PELANGGAN
         public int IdPelanggan
         {
             get { return IdPelanggan; }
         }
+        /// <summary>
+        /// List string berisi nama berkas-berkas yang sudah pernah dipesan lalu diambil oleh pelanggan.
+        /// </summary>
         public List<string> BerkasDimiliki
         {
             get { return _berkasDimiliki; }
         }
 
-        // Behaviour pelanggan
+        // BEHAVIOUR PELANGGAN
+        /// <summary>
+        /// Pelanggan memesan berkas kepada percetakan untuk dicetak.
+        /// </summary>
+        /// <param name="namaBerkas">Nama berkas yang dipesan.</param>
+        /// <param name="isEkspres">Bernilai true jika pesanan ekspres, bernilai false jika pesanan biasa.</param>
         public void Pesan(string namaBerkas, bool isEkspres) {
             Percetakan.TerimaPesanan(new Pesanan(_idPelanggan, namaBerkas, isEkspres));
         }
+        /// <summary>
+        /// Pelanggan mengambil berkas yang sudah dicetak oleh percetakan.
+        /// </summary>
         public void AmbilPesanan() {
             foreach (Pesanan pesanan in Percetakan.BerkasTercetak)
                 if (pesanan.idPelanggan == _idPelanggan)

diff --git a/SimulasiAntrianPercetakan/Percetakan.cs b/SimulasiAntrianPercetakan/Percetakan.cs
@@ -6,16 +6,17 @@
 
 namespace SimulasiAntrianPercetakan
 {
+    // Kelas static karena hanya ada satu instance saja.
     static class Percetakan
     {
-        // Atribut percetakan
+        // ATRIBUT PERCETAKAN
         private static Queue<Pesanan> _antrianBiasa = new Queue<Pesanan>();
         private static Queue<Pesanan> _antrianEkspres = new Queue<Pesanan>();
         public static List<Pesanan> BerkasTercetak = new List<Pesanan>();
         private static int _jumlahPrinter = 1;
         private static int _jumlahPrinterOn = 1;
 
-        // Property percetakan
+        // PROPERTIES PERCETAKAN
         public static int JumlahPrinter{
             get {return _jumlahPrinter; }
             set {
@@ -25,9 +26,15 @@ public static int JumlahPrinter{
                     // Maka dilakukan penyesuaian:
                     _jumlahPrinterOn = _jumlahPrinter; }
         }
+        /// <summary>
+        /// Antrian pesanan berjenis biasa.
+        /// </summary>
         public static List<Pesanan> AntrianBiasa {
             get { return _antrianBiasa.ToList(); }
         }
+        /// <summary>
+        /// Antrian pesanan berjenis ekspres.
+        /// </summary>
         public static List<Pesanan> AntrianEkspres
         {
             get { return _antrianEkspres.ToList(); }
@@ -42,14 +49,22 @@ public static int JumlahPrinterOn{
                     _jumlahPrinterOn = _jumlahPrinter; }
         }
 
-        // Behaviour percetakan
+        // BEHAVIOUR PERCETAKAN
+        /// <summary>
+        /// Percetakan menerima pesanan dari pelanggan.
+        /// </summary>
+        /// <param name="pesanan">Detail terkait pesanan.</param>
         public static void TerimaPesanan(Pesanan pesanan)
         {
             if (!pesanan.isEkspres)
                 _antrianBiasa.Enqueue(pesanan);
             else
                 _antrianEkspres.Enqueue(pesanan);
         }
+        /// <summary>
+        /// Percetakan mencetak pesanan dengan nomor urut paling awal. Pesanan ekspres selalu lebih awal dari pesanan biasa.
+        /// </summary>
+        /// <returns>Kembalian berupa pesanan yang dicetak.</returns>
         public static Pesanan Cetak()
         {
             if (_antrianEkspres.Any())

diff --git a/SimulasiAntrianPercetakan/Pesanan.cs b/SimulasiAntrianPercetakan/Pesanan.cs
@@ -8,13 +8,18 @@ namespace SimulasiAntrianPercetakan
 {
     class Pesanan
     {
-        // Atribut nota pesanan
+        // ATRIBUT PESANAN
         public int idPelanggan;
         public string namaBerkas;
         public bool isEkspres;
         public int timeStamp;
 
-        // Constructor Pesanan
+        /// <summary>
+        /// Konstruktor kelas Pesanan.
+        /// </summary>
+        /// <param name="idPelanggan">Nomor pelanggan yang memesan.</param>
+        /// <param name="namaBerkas">Nama berkas yang dipesan.</param>
+        /// <param name="isEkspres">Bernilai true jika pesanan ekspres, bernilai false jika pesanan biasa.</param>
         public Pesanan(int idPelanggan, string namaBerkas, bool isEkspres)
         {
             this.idPelanggan = idPelanggan;