Syntax Komentar didalam Dart

Kurnia Andi Nugroho

Tue, 17 Sep 2024

Setiap bahasa pemrogramman mempunyai ciri-ciri masing masing didalam syntax komentar. Eits ini bukan komentar pedas ya hehehe. Komentar disini digunakan untuk mempermudah dalam pengembangan apliikasi. Dengan adanya fitur baris komentar, seseorang menjadi lebih mudah dalam mempelajari atau mengembangkan sebuah aplikasi.

Didalam dart, terdapat tiga jenis syntax comments line yang bisa kita gunakan.

1. **Inline Comments **//

Penggunaan syntax komen ini biasanya digunakan untuk memberiikan penjelasan singkat terhadap suatu baris kode. Contoh seperti pada gambar dibawah ini:

Dalam best practices nya, penulisan comment diiawali dengan huruf besar. Ini juga menerapkan kapitalisasi

2. Blocks of comments /* ... */

Kita biisa menggunakan komentar yang ke-dua ini dan menerapkan nya terhadap baris kode yang tidak digunakan sementara. Banyak darii kita menggunakan blocks of comments ini untuk menjelaskan baris kode dan itu bersifat bad practices.

Adapun best practices dalam penulisan block comments bisa dilihat pada gambar diibawah ini:

3. Documentation Comments ///

Penulisan comments menurut standart bahasa dart yang bersifat best practices yang ketiga adalah dengan menggunakan 3 tanda slash. Tanda ini bisa di implementasikan terhadap baris kode yang bertujuan untuk menunjukan sebuah dokumentasi. Berbeda dengan penerapan Block Comments, untuk document comment bisa di implementasikan didalam baris kode yang bersifat tidak sementara dalam artian adalah bersifat permanen. Berikut contoh best practice nya,

Dalam penulisan Doc Comments , usahakan menggunakan kalimat yang ringkas dan memahamkan. Jika memungkinkan untuk memberikan beberapa penjelasan, kita bisa menambahkan blank line, yang artinya memberikan spasi antara comments satu dengan lainnya.