可以生成HTML、LaTeX、Man Pages、RTF跟XML,不過我只有用HTML。
支援C/C++/Java/C#/PHP/Fortran/VHDL,
會將你的程式碼讀入,生成簡明易懂的說明文件,
並將交互參照的部份自動建立連結。
當然,沒有註解的話它並不會自己幫你生成註解,註解還是得你自己寫 XD
註解該怎麼寫才會被讀到,請參考官網文件
不確定其他版本狀況,不過Windows版有一個有GUI的Wizard,
可以經過簡單的設定之後就生成文件出來。
如果想要自己詳細設定的話,Expert Tab裡也可以調。
以下註記一些比較需要注意或是容易忘記的memo...
- Source code directory可以有複數個。要在Expert→Input→INPUT調。
- 對於某些source code不能寫成UTF-8的project,可以用它的轉碼功能。
- 像部分C/C++ compiler不吃UTF-8原始檔,要轉碼成UTF-8再生成文件又大費周章
- 但要注意有些狀況轉碼會失敗....比如說,我從big5轉UTF-8,內含「/」好像就會失敗。不確定為什麼。
- 如果要顯示Static function或private method/member,要到Expert → Build → EXTRACT_PRIVATE / EXTRACT_STATIC調。
- 要顯示目錄(比如說,如果文件包括好幾個小project,彼此是用目錄來區分的),要到Expert → Build → EXTRACT_PRIVATE/SHOW_DIRECTORIES調。
- 原本是設計給英文語系用的,所以一部份地方要注意一下。比如說,他會自動將class name/file name等辨識並加連結,但是如果這些跟中文連在一起的話就不會識別出來(英文的字是以空格分開的嘛),所以最好這類名稱前後都各加空格格開。