lifelong learner — urip iku urup, currently working on accenture.

Cara Membuat Dokumentasi Kode pada Typescript yang Benar

0
Degananda.com -

code_documentation

Terdapat suatu paradigma dalam dunia software engineering terkait dengan dokumentasi pada kode.

kode dengan syntax penulisan dan struktur yang benar tidak membutuhkan dokumentasi karena ditulis dengan baik sehingga mudah dibaca.

kalimat diatas dapat menjadi benar dan dapat menjadi salah. Apabila kode tersebut hanya memiliki 2 atau 3 baris. Memang benar bahwa, kode tersebut akan mudah untuk dibaca.


Namun, apabila suatu kode memiliki ratusan baris serta terdapat banyak sekali aturan-aturan kebutuhan bisnis didalamnya, tentu meski kode tersebut di tuliskan dengan baik dan terstruktur, bagi seorang developer (terutama new joiner) akan mengalami kesusahan dalam memahaminnya dengan cepat.

Cara Membuat Dokumentasi Kode pada Typescript yang Benar

Oleh karena itu, alangkah baiknya apabila kode yang telah dituliskan dengan baik dan memilikis struktur yang tertata rapi juga memiliki dokumentasiHal ini akan menambah readability dari kode itu sendiri.

Syntax untuk Membuat Dokumentasi Kode Pada Typescript.

Pada kasus typescript, untuk membuat dokumentasi ini, tidak memerlukan tambahan library NPM ataupun library dari visual studio code. Sudah terdapat built in syntax untuk membuat dokumentasi.

    /**
     * function function description
     * @remarks
     *
     *
     * @param parameter - description
     * @returns - description
     *
     */

contoh implementasinnya dapat digunakan pada setiap fungsi yang ada pada class. Sehingga, penggunaan dokumentasi diatas hanya berlaku apabila kode typescript ditulis dengan konsep OOP (Object oriented programming).

class Person {
    /**
     * function that will return full name of a person
     * @remarks
     *
     *
     * @param firstName - firstname of the person
     * @param lastName - last name of the person
     * @returns return merged firstname and lastname
     *
     */
    public getMyName(firstName : string, lastName : string){
        return firstName+''+lastName;
    }
}
const dega = new Person();
dega.getMyName("degananda","priyambada");

pada contoh diatas, terdapat satu fungsi public getMyName() yang ditulis dengan syntax dokumentasi. Dokumetnasi tersebut dapat dilihat dengan cara melakukan mouse hover pada syntax dega.getMyname().

typescript_documentation_visualstudiocode.jpg

sangat efisisien bukan? dokumentasi akan muncul langsung pada saat developer melakukan pemanggilan fungsi dari object tersebut dalam bentuk popup window.

(Visited 16 times, 1 visits today)

Leave a Reply