使用doxmate生成文件

2022-07-12 05:36:11 字數 564 閱讀 8236

主頁:

3. 安裝doxmate : 開啟cmd 執行 npm install doxmate -g 

到此已安裝完成;

在包含package.json 、readme.md的目錄下執行doxmate build

或者:doxmate build -o output -s wordpress 

此目錄下:

api.html : 掃瞄lib下面的js生成的文件

doc.html : 掃瞄doc目錄下面的md檔案,生成的文件

index.ejs : 生成doc目錄下面的md檔案的索引

header.ejs : 頁面頭部

footer.ejs : 頁面尾部

sidebar.ejs : lib下面js生成的文件內容

section.html : lib下面js生成的文件的索引

也可以修改base.css 

檔名前面下劃線越多,排名越靠前,在header.ejs 中修改

var keys = object.keys(docs);

keys.sort(function (a, b) );

使用Swagger自動生成文件

swagger 是乙個規範和完整的框架,用於生成 描述 呼叫和視覺化 restful 風格的 web 服務。springfox 的前身是 swagger springmvc,是乙個開源的 api doc 框架,可以將我們的 controller 的方法以文件的形式展現,基於 swagger。官網 第...

beego api自動生成文件

必須設定在 routers router.go 中,檔案的注釋,最頂部 apiversion 1.0.0 title mobile api description mobile has every tool to get any job done,so codename for the new mo...

Django 自動生成文件

老是忘 記錄下 coreapi pip install coreapi rest framework from rest framework.documentation import include docs urls urlpatterns url api include docs urls ti...