Java和.net環境下都有工具可以把代碼中的注釋提取出來,python在這方面也不示弱,pydoc就可以作到這一點。
Pydoc是從python的2.1版本就加入到其標準庫中的。當我們在命令列解譯器中調用help()命令時,就使用他來在控制台上顯示代碼中的注釋。我們也可以使用他來把module中的注釋提取出來,按照一定的組織方式產生該module的說明文檔,包括類,方法等。
Pydoc的原始碼可以在python的安裝目錄的lib檔案夾內找到(我安裝的是2.4)。
使用pydoc時,你可以使用-w參數來對指定的模組產生一個Html文檔。
例如:pydoc.py –w string
這樣就會在目前的目錄產生一個對應的HTML檔案。
如果要給某個目錄下的所有模組產生HTML檔案。可以使用:
pydoc.py –w Z:\
你還可以使用-p參數來啟動一個本地網站,這樣你就可以在瀏覽器中查看modules的說明了,例如:
pydoc -p 1234 -w z:\
執行完此命令,在瀏覽器中輸入地址:http://localhost:1234/,就可以查看modules的說明了。怎麼樣,產生的文檔還不錯把。
如果你對產生的效果不滿意,可以自己開啟pydoc.py檔案來修改自己喜歡的樣式。
另外還有一個doc產生工具:pythondoc。
VS.net中的程式碼摺疊功能是一項很不錯的功能,特別是代碼比較長的時候,可以使代碼閱讀起來容易些。在python中雖然預設的IDLE沒有這個功能,但是pythonwin這個IDE有這功能,在編輯.py檔案時,可以看到在代碼編輯器左邊有一欄,在“class”,“def”等關鍵字旁有小橫杠樣的標記,點擊後會變成加號,同時摺疊這部分的代碼,不單是“class”,“def”等關鍵字,甚至連if,else,for等都可以摺疊。
這讓我不由想到以前看delphi代碼時的痛苦,代碼一多,閱讀起來只能用上下翻飛來形容。而這樣的一個功能,pythonwin這樣的由個人寫的IDE都實現了,可是borland卻一直沒有給delphi加上,讓人感慨python的活力的同時,為borland感到惋惜。