一個程式的文件產生工具 - Doxygen |
|
frederick
中階會員 發表:101 回覆:108 積分:66 註冊:2002-08-01 發送簡訊給我 |
什麼是Doxygen? 摘要:(此段落取自「中文說明」所連結之網頁) Doxygen 是一個程式的文件產生工具,可將程式中的特定註解轉換成為說明文件。通常我們在寫程式時,或多或少都會寫上註解,但是對於其他人而言,要直接探索程式裡的註解,與打撈鐵達尼號同樣的辛苦。大部分有用的註解都是屬於針對函式,類別等等的說明。所以,如果能依據程式本身的結構,將註解經過處理重新整理成為一個純粹的參考手冊,對於後面利用您的程式碼的人而言將會減少許多的負擔。不過,反過來說,整理文件的工作對於您來說,就是沈重的負擔。 一個好的程式設計師,在寫程式時,都會在適當的地方加上合適的註解。如果,能夠在撰寫註解時,稍微符合某種格式,接著就可以透過一個工具程式依據程式結構及您的註解產生出漂亮的文件。這將令許多工作繁重的程式設計師有時間多喝幾杯咖啡。 Doxygen 就是這樣的一個工具。在您寫註解時,稍微按照一些它所制訂的規則。接著,他就可以幫您產生出漂亮的文件了。因此,Doxygen 的使用可分為兩大部分。首先是特定格式的註解撰寫,第二便是利用Doxygen的工具來產生文件。 目前Doxygen可處理的程式語言包含:
C/C++
Java
IDL (Corba, Microsoft及KDE-DCOP類型) 而可產生出來的文件格式有:
HTML
XML
LaTeX
RTF
Unix Man Page
而其中還可衍生出不少其他格式。如有了LaTeX 文件後,就可以透過一些工具產生出PS或是PDF檔案。 在多國語言的支援方面,Doxygen 目前可支援的約有2,30種。自Doxygen 1.2.16開始支援繁體中文(這正是小弟做的好事)。所以在目前一些Open Source 的程式文件產生器中,Doxygen 算是相當完整的一套。在程式語言處理上面,Doxygen也算是少數在Borland C++ Builder 的語法下還能夠正常運作的工具之一(若非如此,小弟也不會推薦它)。 本文的目的是希望在經過仔細閱讀本文之後能夠給大家一個概略性的瞭解。以便可以很容易的上手使用Doxygen。至於Doxygen本身的詳細使用,各位可以參考隨著Doxygen 所附的文件。實際上,Doxygen 自己的使用手冊就是使用Doxygen 產生的。您可以看到他實際上能夠產生遠比Reference Book更複雜的文件。 中文說明:http://www.stack.nl/~dimitri/doxygen/doxygen_intro_cn.html 作者:Gary W. Lee
原始網站:http://www.stack.nl/~dimitri/doxygen/ 發表人 - frederick 於 2003/09/07 23:15:57
|
James
高階會員 發表:10 回覆:290 積分:220 註冊:2002-07-25 發送簡訊給我 |
|
frederick
中階會員 發表:101 回覆:108 積分:66 註冊:2002-08-01 發送簡訊給我 |
引言: 不錯的工具, 雖然 Open source 中也有人提供可以處理 Pascal 的檔案, 但是可能是我太笨了 ,一直沒有辦法成功 !! 不知 frederick 能否提供 一下該怎麼來配合 Delphi 使用 !! 目前看起來似乎又只能用 doc-o-matic 但那又要花不少銀兩 ,中文處理也有問題... 要找到合用的工具還真麻煩 !!James您好: 它應有附source code,您可參考看看。 Doxygen目前可處理的程式語言包含: C/C Java IDL (Corba, Microsoft及KDE-DCOP類型) 其他語言,我想是語彙分析方面的問題? 或許可從source code當中改成您想要的。 |
阿子
站務副站長 發表:120 回覆:230 積分:201 註冊:2002-03-18 發送簡訊給我 |
James 兄
若您是要類似Doxygen工具在 for Pascal語法 ,除了商業的doc-o-matic
之外還是有free 跟open source 的.
1.XHelpGen <--是KOL 函式庫內附的一個工具 FREE 不過不提供SOURCE 。
網址:http://bonanzas.rinet.ru/
2.PasDoc <-- SourceForge.net 上的一個專案目前到0.8.7今年四月出的版本。
網址:http://sourceforge.net/projects/pasdoc/
提供給您參考
<>從思考取勝一切~> 發表人 - 阿子 於
------
從思考取勝一切~q |
James
高階會員 發表:10 回覆:290 積分:220 註冊:2002-07-25 發送簡訊給我 |
本站聲明 |
1. 本論壇為無營利行為之開放平台,所有文章都是由網友自行張貼,如牽涉到法律糾紛一切與本站無關。 2. 假如網友發表之內容涉及侵權,而損及您的利益,請立即通知版主刪除。 3. 請勿批評中華民國元首及政府或批評各政黨,是藍是綠本站無權干涉,但這裡不是政治性論壇! |