Documentation Generator jsdoc dan Express Framework

documentation generator merupakan programming tool yang berguna untuk membuat dokumentasi dari program. biasanya dokumentasi diperuntukan kepada programmer atau pengguna/user

document generation bisa dibagi menjadi 4 tipe yaitu:

  • Batch documents (all automated documents)
  • Interactive documents (documents that can not be produced automatically)
  • Text block correspondence (documents created based on pre-defined text blocks)
  • Forms (forms for websites)

salah satu documentation generator untuk javascript adalah JSDoc. untuk menggunakan JSDoc harus telebih dahulu mendownload dan install JSDoc dengan cara npm install jsdoc. setelah itu buat sebuah tag komen sebelum fungsi, variabel, parameter dll yang diinginkan untuk dimasukkan ke dokumentasi.

/**
* @param {String} name
* @returns {Object}
*/
function getPerson(name) {
}
/** @type {number} */
var carCounter = 0;

setelah selesai, jalankan ./node_modules/.bin/jsdoc yourJavaScriptFile.js atau jsdoc yourJavaScriptFile.js selanjutnya output tersebut akan berada pada folder out dan jika dibuka file index.html akan tampil kira-kira seperti ini

untuk lebih lanjut tetang tag yang digunakan dan beberapa contoh bisa dilihat di http://usejsdoc.org/

Express Framework in NodeJS

express merupakan minimal dan fleksibel Node.js framework web aplikasi yang menyajikan banyak fitur yang digunakan untuk membuat aplikasi web dan mobile. Berikut beberapa core features dari express:

  • dapat mempersiapkan middlewares untuk merespon HTTP Requests
  • mendefinisikan routing table yang digunakan untuk melakukan action menurut HTTP Method dan URL
  • merender halaman HTML secara dinamik

modul-modul yang berguna adalah:

  • body-parser − middleware untung handling JSON, Raw, Text danURL encoded form data.
  • cookie-parser − Parse Cookie header and populate req.cookies with an object keyed by the cookie names.

What is the purpose of it with Node.js?

dengan express kita tidak perlu mengulang code yang sama berulang-ulang. Node.js merupakan low-level I/O mekanisme yang terdapat modul HTTP. jika hanya menggunakan HTTP module, pekerjaan seperti payload parsing, cookies, storing sessions dll harus diimplementasi berulang-ulang sedangkan dengan express sudah disediakan/digunakan.

Untuk lebih lanjut bagaimana cara menggunakan express bisa dilihat di https://nodejs.org/en/

One clap, two clap, three clap, forty?

By clapping more or less, you can signal to us which stories really stand out.