วิธาสร้าง HTML5 Compliant Javadoc ใน Java 9

ก่อน Java 9 ต้องค้นหาใน Google เพื่อหา packages, classes, interfaces, methods information ตั้งแต่ Java 9 Javadoc รวม search options ใน API documentation เอง และ output เป็น HTML5 compliant

ตัวอย่าง

สร้างไฟล์ JavaDocTest.java ในโฟลเดอร์ C:/JAVA


public class JavaDocTest {
    /**
     * Default method to be run to print
     * Tutorialspoint
     * @param args command-line arguments
     */
    public static void main(String args[]) {
        System.out.println("Tutorialspoint");
    }
}

Generate Javadoc ด้วย HTML5


C:\JAVA> javadoc -d C:/JAVA -html5 JavaDocTest.java
Loading source file JavaDocTest.java...
Constructing Javadoc information...
Standard Doclet version 9.0.4
Building tree for all the packages and classes...
Generating C:\JAVA\JavaDocTest.html...
Generating C:\JAVA\package-frame.html...
Generating C:\JAVA\package-summary.html...
Generating C:\JAVA\package-tree.html...
Generating C:\JAVA\constant-values.html...
Building index for all the packages and classes...
Generating C:\JAVA\overview-tree.html...
Generating C:\JAVA\index-all.html...
Generating C:\JAVA\deprecated-list.html...
Building index for all classes...
Generating C:\JAVA\allclasses-frame.html...
Generating C:\JAVA\allclasses-noframe.html...
Generating C:\JAVA\index.html...
Generating C:\JAVA\help-doc.html...

คำสั่งด้านบนสร้าง documentation ภายใต้โฟลเดอร์ C:/JAVA ตามรูป:

วิธาสร้าง HTML5 Compliant Javadoc ใน Java 9

คุณสมบัติใหม่ของ Javadoc ใน Java 9

Feature	คำอธิบาย
HTML5 Output	ใช้ `-html5` flag สร้าง valid HTML5
Search Box	ค้นหา classes, methods, packages ในหน้า doc ได้เลย
Module Summary	แสดง module graph และ dependencies
Improved Navigation	Sidebar, breadcrumbs, keyboard shortcuts
Responsive Design	ทำงานได้ดีบน mobile/tablet

Javadoc Options สำคัญ


# Basic
javadoc -d docs -html5 src/**/*.java

# With module path
javadoc -d docs -html5 --module-path mods -sourcepath src -subpackages com.myapp

# Include/exclude packages
javadoc -d docs -html5 -subpackages com.myapp -exclude com.myapp.internal

# Custom tags
javadoc -d docs -html5 -tag customtag:a:"Custom Tag:"

# Overview file
javadoc -d docs -html5 -overview overview.html src/**/*.java

# Locale
javadoc -d docs -html5 -locale en_US src/**/*.java

HTML5 vs HTML4 Output

DOCTYPE: <!DOCTYPE html> แทน DTD declaration ยาวๆ
Semantic tags: <header>, <nav>, <main>, <section>, <article>, <footer>
No frames option: Default ไม่ใช้ frames (แต่ยังมี -frames flag)
Better accessibility: ARIA attributes, proper heading hierarchy
CSS improvements: Modern styling, print stylesheet

การตรวจสอบ HTML5 Validity


# ใช้ W3C validator
java -jar vnu.jar docs/**/*.html

# หรือ online validator
# https://validator.w3.org/