Dokumentasi

Code is read much more often than it is written

Guido van Rossum, founder dari bahasa pemrograman Python menjelaskan bahwa seorang Developer atau Engineer lebih banyak menghabiskan waktu untuk membaca suatu kode ketimbang menulisnya.

Sebuah dokumentasi dapat digunakan untuk menjelaskan bagian kompleks dari suatu kode, sehingga memudahkan Developer atau Engineer memahami suatu kode serta memudahkan proses kolaborasi antar tim.

Hal ini menunjukkan pentingnya menulis sebuah kode yang terdokumentasi dengan baik.

Tipe Dokumentasi

Inline Comment

Inline comment disebut juga code comment merupakan tipe dokumentasi singkat yang ditulis dalam satu baris. Inline comment digunakan untuk memperjelas maksud dari suatu baris dalam sebuah kode.

Pada javascript, sebuah inline comment selalu diawali dengan tanda double slash (//) seperti contoh berikut.

let total = 0; // Inisialisasi nilai total

Docstring

Docstring atau document string merupakan tipe dokumentasi yang biasanya ditulis dalam beberapa baris. Docstring digunakan untuk menjelaskan suatu bagian tertentu dalam sebuah kode program, seperti sebuah function, class, module, dll.

Berikut contoh penggunaan dockstring dalam javascript.

/**
 * Function to calculate total price.
 * @param {number} price - The price of the item.
 * @param {number} quantity - The quantity of the item.
 * @returns {number} The total price.
 */
function calculateTotal(price, quantity) {
    return price * quantity;
}

Project Documentation

Project documentation merupakan tipe dokumentasi yang terpisah dengan kode program. Project documentation digunakan untuk memberi penjelasan detail tentang sebuah proyek dan umumnya ditulis dalam sebuah berkas README.md.

Beberapa contoh project documentation dapat dilihat pada tautan di bawah ini.

https://github.com/nursandiid/tutorial-membuat-aplikasi-point-of-sales/blob/main/README.md

https://github.com/belajarkoding/store-documentation/blob/master/README.md

The easiest way to create a README

README.so adalah tool yang memungkinkan membuat README dengan mudah menggunakan editor grafis. Dengan README.so, kamu dapat membuat README yang menarik dan informatif tanpa harus menulis kode Markdown secara manual.