【背景】

之前折騰技術(shù)的時候，或多或少，知道一個東西：

DocxyGen

是用于從代碼生成文檔的。

最近，又從：

->

該地址無效，但是自己手動輸入地址，而找到：

看到頁面右下角，就顯示了，此在線文檔是通過DocxyGen去生成的。

然后就打算去試試，抽空把我的python代碼：

通過DocxyGen去生成文檔看看。

【折騰過程】

1.目前搜到的一些，有參考價值的資料：

(1)官網(wǎng)：

介紹了一些基本的使用方法。

介紹了些最基本的格式。

但是說明的不詳細。

(3)Nokia的wiki：

介紹了稍微更詳細點。

(4)從：

找到：

->

->

(5)最終找到官網(wǎng)：

然后才是最終最全，最權(quán)威的解釋：

不僅解釋了格式，并且給出了兩種寫法的效果：

支持doxygen自己的特殊命令(special command)的效果(當然效果更好)：Class Index

并且也提到了相關(guān)參數(shù)：

有空好好研究研究。

注：

由于已經(jīng)看到此處官網(wǎng)提到，內(nèi)在支持python了，所以，無需再用之前的doxypy去將python 的doc string轉(zhuǎn)換為對應(yīng)的docxygen的格式了。

2.有空，直接去看官網(wǎng)最全最系統(tǒng)的資料：

包含了：

等等內(nèi)容。

3.對應(yīng)的，很多有價值的資料：

(3)命令行工具本身如何使用：Doxygen usage

4.后來看到：doxypy的升級版doxypypy，貌似做的不錯，有機會也可以去試試。

【總結(jié)】

目前看來，DocxGen，真的是不錯的東西。有空需要好好研究研究。

總結(jié)

以上是生活随笔為你收集整理的python docx官网_【记录】尝试用DocxyGen为Python代码生成文档的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。