用 Markdown 撰寫 Java 程式碼的說明文件

Javadoc 是 Java 的文件產生工具，可以讀取 Java 原始程式碼的註解文字，自動產生專案的程式說明文件。

舉例來說，一個簡易的 Class 註解文字可能長這樣：


雖然只是簡單的說明文字，但使用 HTML 撰寫還是很討厭，因為在程式碼中閱讀這些註解並不直覺。

如果改用 Markdown 語法撰寫，程式碼註解的可讀性就提高不少。

但是 Javadoc 最後仍需要產生 HTML 格式的文件，它並不認得、也不會去轉換這些 Markdown 語法。

此時我們可以加入 markdown-doclet 這個套件，它讓程式碼的註解可以用更直覺的 Markdown 語法撰寫，最後幫忙轉換成 HTML 格式，並且還會加入 UML 圖形。

＊ 雖然使用 Markdown 語法撰寫 Java 程式註解，是個不錯的構想，但可惜的是實際使用的案例並不多，且 markdown-doclet 專案在 2010 年之後就不再更新。