Komentar #

Dalam TypeScript, komentar digunakan untuk menjelaskan kode, mendokumentasikan fungsionalitas, atau untuk menonaktifkan bagian kode tanpa menghapusnya. Ada beberapa jenis komentar yang dapat digunakan dalam TypeScript, yang mirip dengan JavaScript. Berikut penjelasan mengenai berbagai macam implementasi komentar pada TypeScript:

Komentar Satu Baris (//) #

Komentar satu baris digunakan untuk menambahkan komentar pada satu baris kode. Apa pun yang ditulis setelah // pada baris tersebut akan diabaikan oleh compiler.

let x = 10; // Ini adalah komentar satu baris
console.log(x); // Mencetak nilai x

Komentar ini cocok untuk menjelaskan pernyataan atau baris kode yang sederhana.

Komentar Multi-Baris (/*...*/) #

Komentar multi-baris digunakan ketika Anda perlu menulis komentar yang lebih panjang atau ketika Anda ingin mengomentari lebih dari satu baris kode.

/*
Ini adalah komentar multi-baris.
Komentar ini dapat mencakup beberapa baris.
*/
let x = 10;
let y = 20;
let z = x + y; /* Komentar ini juga bisa ditempatkan di akhir kode */
console.log(z);

Komentar multi-baris berguna untuk menjelaskan bagian kode yang lebih kompleks atau untuk memberikan dokumentasi yang lebih detail.

Komentar JSDoc (/**...*/) #

Komentar JSDoc adalah jenis khusus dari komentar multi-baris yang digunakan untuk mendokumentasikan kode. Ini biasanya digunakan untuk mendokumentasikan fungsi, kelas, parameter, tipe, dan lain-lain. JSDoc membantu dalam memberikan tipe informasi dan dokumentasi yang lebih terstruktur.

/**
 * Fungsi untuk menambahkan dua angka.
 * @param a - Angka pertama
 * @param b - Angka kedua
 * @returns Hasil penjumlahan dari a dan b
 */
function add(a: number, b: number): number {
      return a + b;
}

Komentar JSDoc sangat berguna karena mereka dapat diproses oleh berbagai alat untuk menghasilkan dokumentasi secara otomatis, dan juga membantu IDE dalam memberikan saran tipe dan dokumentasi saat menulis kode.

Komentar untuk Menonaktifkan Baris Kode #

Anda juga bisa menggunakan komentar untuk menonaktifkan sementara bagian kode, misalnya ketika Anda ingin menguji sesuatu tanpa menghapus kode tersebut.

let x = 10;
// console.log(x); // Baris ini tidak akan dieksekusi
x += 5;
console.log(x);

Teknik ini sering digunakan saat debugging atau ketika mencoba berbagai solusi pada kode.

Komentar @ts-ignore #

TypeScript memiliki anotasi khusus yang disebut @ts-ignore, yang digunakan untuk mengabaikan error TypeScript pada baris tertentu. Ini bisa berguna saat Anda yakin bahwa baris tersebut aman tetapi TypeScript menandainya sebagai error.

// @ts-ignore
let y: number = "10"; // TypeScript biasanya akan menandai ini sebagai error, tetapi diabaikan

Anotasi ini harus digunakan dengan hati-hati karena mengabaikan pemeriksaan tipe bisa menyebabkan masalah runtime.

Kesimpulan #

Dengan memahami berbagai macam implementasi komentar di TypeScript, Anda dapat menulis kode yang lebih terstruktur, terdokumentasi dengan baik, dan mudah untuk dipahami oleh pengembang lain atau diri sendiri di masa depan.