Tuesday, February 22, 2005

Pydoc

寫文件註解在團對開發專案有很大的助益。對於開發團隊所提供的API,如果可以透過html或是其他方式的呈現,在使用API會有幫助。如Python在 互動模式(active mode)提供help([method, class, module])查詢相關使用方式,以純文字的方式展現,當然,也可以前往Python的官方網站去下載HTML版本的Libraries索引。雖然這些都是相當方便,但是,java的開發者應該不會忘記提供查詢API資訊的Javadoc。透過javadoc,在程式中的註解項目(如methodA要傳入什麼參數,傳回什麼參數,會引發什麼Exception……等)可以轉換成HTML的呈現模式,利用瀏覽器的點選,方便使用。

Python當然也有這麼好用的東西,就是epydoc。epydoc提供的fields跟javadoc差不多,但是因為語言的特性不同,如變數的型別方便,epydoc有”@type param”的描述,可以建議使用者傳入或傳出的參數,應該是什麼型別。更詳細的內容,可以參考epydoc的文件

除了epydoc,Python安裝完後,會提供pydoc。這個Py檔,執行時在本機開一個port,讓用者透過瀏覽器的方式看內建以及你自訂安裝的 py套件(文字模式的使用者,可以用lynx)。如果作業平台是windows,這個連結會在"Modules Doc",其實就是去呼叫pydoc.gui(),而文字模式的是去呼叫pydoc.cli()。內定的port是7464,可以透過-p port這個參數修改。呈現出來的內容就是使用help({modules,class,method,variable})指令看到的那些囉。

No comments: