JDK 28 Rich JavaDoc: แท็ก @note ไฮไลต์คำเตือนในเอกสาร API

เขียน JavaDoc แล้วอยากเน้นคำเตือนให้เด่นกว่าย่อหน้าปกติไหมครับ — เมื่อ 23 ก.ย. 2026 Billy Korando บน Inside.java ส่งหัวข้อ Quality Outreach เรื่องแท็ก @note ใน JDK 28

สรุปจากโพสต์:

• ใช้แบบอินไลน์ได้ เช่น {@note There is always a maximum foo...} → เรนเดอร์เป็นบล็อก Note: คู่แถบข้าง
• ใส่แอตทริบิวต์ในวงเล็บ เช่น {@note (header='Caution:') Untrusted input must be verified!}
• แอตทริบิวต์ที่ Standard Doclet รู้จักรวม header, kind (เพิ่ม CSS class), id
• สร้างแท็กคัสตอมด้วย javadoc -tag 'warning:A:Warning:' ให้เป็น alias ของ @note
• รายละเอียดเพิ่มใน JDK-8363700 — ยังเป็นข้อเสนอที่ชวนโปรเจกต์ FOSS ช่วยเทสต์กับบิลด์ OpenJDK

ถ้าดูแลไลบรารีสาธารณะ ลองใส่ @note ใน early-access Javadoc แล้วส่งฟีดแบ็กไปที่ javadoc-dev ตามที่โพสต์ชวน

Recap

• อ่านInside.java
• ลอง @note / custom -tag บน JDK 28 EA กับโมดูลเล็ก ๆ
• แยก “เคล็ดลับ” กับ “Caution” ด้วย header ให้ผู้อ่านสแกนเร็ว