Javadoc 是 Java 的文件產生工具,可以讀取 Java 原始程式碼的註解文字,自動產生專案的程式說明文件。
舉例來說,一個簡易的 Class 註解文字可能長這樣:
雖然只是簡單的說明文字,但使用 HTML 撰寫還是很討厭,因為在程式碼中閱讀這些註解並不直覺。
如果改用 Markdown 語法撰寫,程式碼註解的可讀性就提高不少。
但是 Javadoc 最後仍需要產生 HTML 格式的文件,它並不認得、也不會去轉換這些 Markdown 語法。
此時我們可以加入 markdown-doclet 這個套件,它讓程式碼的註解可以用更直覺的 Markdown 語法撰寫,最後幫忙轉換成 HTML 格式,並且還會加入 UML 圖形。
* 雖然使用 Markdown 語法撰寫 Java 程式註解,是個不錯的構想,但可惜的是實際使用的案例並不多,且 markdown-doclet 專案在 2010 年之後就不再更新。
訂閱:
張貼留言 (Atom)
-
▼
2011
(197)
-
▼
10月
(20)
- 用 gist 指令快速建立程式碼剪貼簿(code snippets)
- 敏捷 Java 開發之 Gradle 專案自動化工具介紹
- 創業×閱讀 (一) 創業首部曲
- Linux Journal 全面數位化 + 免費的九月號
- Universal Subtitles 讓世界各地的用戶幫影片打上字幕
- 再談數位出版,易讀網及便宜的電子書閱讀器 EZRead Touch
- 環保節能、待機時間超長的 Boogie Boar RIP 電子塗鴉板
- 用 Markdown 撰寫 Java 程式碼的說明文件
- 除了 JavaScript 你還可以用 Dart 開發 Web 前端!
- Safari + Pure Reader 讓 Google Reader 變美
- 消失的 Gnome 字型配置,Ubuntu 11.10 升級後的系統調校
- 消失的 gedit 色彩配置,Ubuntu 11.10 升級後的系統調校
- 最棒的免費作業系統 Ubuntu 11.10 正式發行
- 友情推廣:台灣電子書研究基地
- 使用 Octopress + GitHub 免費架設部落格,以 Markdown 語法快速發表文章
- SourceTree - 好用的 Git / Mercurial GUI 管理工具 for Mac ...
- Grails 2.0.0M 的 Spock Testing with Mock Domain Object
- 解決 Grails Maven 套件衝突問題
- Sublime Text 文字編輯軟體,支援 Linux、Mac OS X、Windows
- 在 Mac OS X 安裝 RabbitMQ / Erlang
-
▼
10月
(20)
沒有留言:
張貼留言