JEP 467: Komentar Dokumentasi Markdown

Tujuan

Mendukung sintaks Markdown dalam komentar dokumentasi Java untuk meningkatkan keterbacaan dan mendorong penulisan dokumentasi yang lebih ringkas.

Motivasi

• JavaDoc yang ada saat ini bergantung pada tag HTML → terlalu bertele-tele dan sulit dibaca.
• Pengembang sudah akrab dengan Markdown di README, GitHub, dan lainnya.
• Dukungan Markdown memungkinkan penulisan dokumentasi yang konsisten dan ringkas.

Penjelasan

• Mendukung sintaks Markdown berbasis CommonMark di dalam komentar JavaDoc.
• Komentar HTML yang ada tetap dapat digunakan.
• Alih-alih komentar gaya /* ... */ yang ada, digunakan /// untuk menandai bahwa itu adalah komentar dokumentasi Markdown.
• Alat JavaDoc pihak ketiga akan menangani parsing dan rendering Markdown.

Spesifikasi Markdown

• Berbasis CommonMark.
• Sintaks yang didukung:
  • Judul (#, ##, ###, dll.)
  • Daftar (berurutan/tidak berurutan)
  • Blok kode (```)
  • Tautan
  • Tabel (gaya Github Flavored Markdown)
  • Kutipan
  • Penekanan (*miring*, **tebal**)

Tag khusus Java

Tag @ JavaDoc yang ada tetap bisa digunakan bersama Markdown:

• @param
• @return
• @throws
• @see
• @since
• @deprecated

[devnamho0910]

Bagus sekali...

[carnoxen]

Sepertinya itu sudah dimasukkan ke dalam standar.

[click]

Sudah masuk ke JDK23.
Setelah dicoba, meskipun versi JDK proyek di bawah 23, tetap berfungsi normal jika IDE atau alat export Javadoc mendukungnya.