มาลองเขียน comment รูปแบบ Markdown ใน Java 23 กัน

Java 23 ถูกปล่อยออกมาให้ทดลองใช้งาน
โดยที่มีความสามารถหลายตัวที่น่าสนใจ
หนึ่งในนั้นคือ JEP 467 :: Markdown Documentation Comments
ช่วยให้เขียน comment ในรูปแบบของ markdown ได้
ซึ่งสุดท้ายก็ไป generate ออกมาเป็น JavaDoc นั่นเอง
มาลองใช้งานกันดู

ก่อนหน้านี้เขียนในรูปแบบของ HTML ร่วมกับ JavaDoc tag
ซึ่งอาจจะยากต่อการอ่านและเขียน
แต่ถ้าเปลี่ยนมาเขียนในรูปแบบของ markdown จะยากขึ้นไหมนะ
มาเขียนกันดูหน่อย

ก่อนอื่นติดตั้ง Java 23 ก่อนนะ
มาเริ่มเขียนกัน

รูปแบบของการเขียนเป็นดังนี้

• เริ่มเขียน comment ด้วย /// ในทุก ๆ บรรทัด
• รูปแบบของ markdown ตาม spec นี้

[gist id="42d503ff8d13e90a169ac6ed4db3849a" file="Demo.java"]

ทำการ generate JavaDoc

[gist id="42d503ff8d13e90a169ac6ed4db3849a" file="1.txt"]

ได้ JavaDoc ในรูปแบบ HTML ดังนี้

ใน Spring Boot ก็มีการเปิด issue เรื่องนี้เข้าไปแล้วด้วย
ลองเล่นกันดูครับ