ToShowDoc拯救不想寫文件的你

2022-02-21 06:16:01 字數 1353 閱讀 6159

寫注釋已經夠折磨開發者了,顯然天天curd的我們再去寫文件豈不是分分種要被逼瘋.

我想每個人都有這種經歷

已經有swagger的我們慢慢的已經忘掉了寫文件這件事. 但是在某些不方便暴露swagger位址的那天,又回憶起被文件支配的恐懼.

showdoc是乙個文件**商,它提供了乙個良好的結構易於開發者編寫文件. 也提供了api供開發者自動生成文件. 現在toshowdoc把它帶到了net core中

toshowdoc是乙個在github上開源專案,來自被文件折磨的我. toshowdoc將swagger的文件轉換為showdoc的格式並自動新增與更新,下面介紹一下如何使用toshowdoc自動生成文件

使用cmd鍵入以下命令

dotnet tool install -g toshowdoc

基本命令

toshowdoc add 新增乙個專案

toshowdoc update 更新專案資訊

toshowdoc del 刪除乙個專案

toshowdoc list 顯示專案集合

toshowdoc sync 同步專案文件

toshowdoc -h 顯示幫助資訊

用法可參考-h的幫助資訊,例如新增

toshowdoc add -h

執行以下命令

toshowdoc add -n bookstore3.x -ak a338fb0d83c6f4b660bc2706b92e89451844587564 -at e1511a84db06d25150377970f328e9f7572510835 -su https://localhost:44383/swagger/v1/swagger.json -sdu
這時已經新增了乙個專案到toshowdoc中,可以執行list命令進行檢視

現在可以使用sync同步文件, 同步後螢幕會輸出successfully!代表同步成功

這時訪問 可以看到同步的效果.

想寫的,不想寫的

每當學到了新的知識,有一點感觸,就想記錄下來。或者是想留給別人參考,或者方便自己回過頭來查閱,也或者單單就是想寫下來,告訴自己真的學過了。作為學生,所謂的知識,多是來自課堂的。這幾天聽的幾門課,如linux核心分析,設計模式等,都頗有收穫。急迫著想把課堂的收穫記在部落格裡,也看過別人寫過某某著作讀書...

想寫的,不想寫的

每當學到了新的知識,有一點感觸,就想記錄下來。或者是想留給別人參考,或者方便自己回過頭來查閱,也或者單單就是想寫下來,告訴自己真的學過了。作為學生,所謂的知識,多是來自課堂的。這幾天聽的幾門課,如linux核心分析,設計模式等,都頗有收穫。急迫著想把課堂的收穫記在部落格裡,也看過別人寫過某某著作讀書...

我真不想寫背景

某巨魔突然對等式很感興趣,他正在研究 a1 x1 a 2x2 an xn b 存在非負整數解的條件。他要求你編寫乙個程式,給定 n an 以及 b 的取值範圍,求出有多少 b可以使等式存在非負整數解。輸入的第一行包含 3 個正整數,分別表示 n bmin bma x 分別表示數列的長度 b 的下界 ...