my-docs-gen-nita

my-docs-gen-nita adalah alat bantu otomatisasi dokumentasi kode untuk proyek JavaScript berbasis Command Line Interface (CLI). Aplikasi ini dirancang untuk membantu developer menghemat waktu dengan secara otomatis menghasilkan dokumentasi dari komentar JSDoc yang terdapat di dalam kode JavaScript. Proyek ini dikembangkan sebagai bagian dari penelitian Skripsi Program Studi Teknik Informatika.

Fitur Utama

• Parsing JSDoc yang Akurat
  Mampu membaca dan mengurai komentar JSDoc secara lengkap, termasuk deskripsi, parameter, tipe data, nilai kembalian, serta nomor baris kode terkait.

• Format Markdown sebagai Default
  Secara bawaan, alat ini akan menghasilkan dokumentasi dalam format Markdown (.md). Selama pengguna tidak menyetel format ke HTML, maka output otomatis berupa file Markdown.

• Output HTML Opsional
  Dokumentasi dapat dihasilkan dalam format HTML (.html) jika pengguna menyetel format ke html. Mode ini cocok untuk publikasi berbasis web dengan tampilan profesional dan navigasi sidebar.

• CLI yang Fleksibel dan Intuitif
  Mendukung short option dan long option:

  • -i atau --input
  • -o atau --output
  • -f atau --format

• Auto-Config Output
  Folder output akan dibuat secara otomatis jika belum tersedia.

Instalasi

Alat ini dapat diinstal secara global menggunakan NPM agar dapat dijalankan dari direktori proyek mana pun:

npm install -g my-docs-gen-nita

Cara Penggunaan

Setelah terinstal, dokumentasi dapat dihasilkan menggunakan perintah my-docs generate. Jika tidak ada pengaturan format yang diberikan, maka output default adalah Markdown (.md).

Buka terminal di folder proyek JavaScript Anda, lalu jalankan perintah berikut:

1. Perintah Dasar (Default: Markdown)

Memindai folder saat ini (./) dan menghasilkan file docs.md:

my-docs generate

2. Menentukan Folder Input

Gunakan opsi -i atau --input:

my-docs generate -i ./src

atau

my-docs generate --input ./src

3. Menghasilkan Output HTML

Gunakan opsi -f atau --format dengan nilai html:

my-docs generate -f html

atau

my-docs generate --format html

Jika format tidak disetel ke html, maka sistem otomatis menghasilkan dokumentasi Markdown (.md).

4. Kustomisasi Folder Output

Gunakan opsi -o atau --output:

my-docs generate -o ./dokumentasi-saya

atau

my-docs generate --output ./dokumentasi-saya

5. Menggabungkan Semua Opsi dalam Satu Perintah

Seluruh opsi CLI dapat digabungkan dalam satu perintah sesuai kebutuhan. Contoh berikut akan:

• Membaca kode dari folder ./src
• Menghasilkan dokumentasi format HTML
• Menyimpan hasil ke folder ./docs-output

my-docs generate -i ./src -f html -o ./docs-output

Contoh lain menggunakan long option sepenuhnya:

my-docs generate --input ./src --format html --output ./docs-output

Kedua perintah tersebut ekuivalen dan dapat digunakan sesuai preferensi pengguna.

6. Bantuan

Untuk melihat seluruh opsi CLI yang tersedia:

my-docs generate --help

Contoh Hasil

Kode Sumber (math.js)

/**
 * Menghitung luas persegi panjang.
 * @param {number} panjang - Sisi panjang dari persegi.
 * @param {number} lebar - Sisi lebar dari persegi.
 * @returns {number} Luas persegi panjang.
 */
function hitungLuasPersegi(panjang, lebar) {
  return panjang * lebar;
}

Dokumentasi Markdown yang Dihasilkan (Default)

### hitungLuasPersegi

Menghitung luas persegi panjang.

**Parameter:**
- `panjang` (number): Sisi panjang dari persegi.
- `lebar` (number): Sisi lebar dari persegi.

**Returns:**
- `number`: Luas persegi panjang.

Kontributor

Qonita Nadya Ramadhani
Universitas Islam Negeri Sunan Kalijaga Yogyakarta