快捷轉換/互轉 Markdown 文檔和 TypeScript/TypeDoc 註釋

背景

作爲文檔工具人，經常需要把代碼裏面的註釋轉換成語義化的 Markdown 文檔，有時也需要進行反向操作。以前是寫正則表達式全局匹配，時間長了這種方式也變得繁瑣乏味。所以寫了腳本來互轉，增加一些便捷性。

解決方案

註釋轉 Markdown

下載地址：https://github.com/mazeyqian/go-gin-gee/releases/tag/v1.2.0

操作步驟：

1. 跟自身系統下載文件 convert-typedoc-to-markdown-mac-darwin-amd64/...
2. 在同個目錄下新建一個文件夾 data
3. 在文件夾 data 內新建一個文件 td2md.js
4. 在將需要被轉換的註釋放在文件 td2md.js
5. 執行 convert-typedoc-to-markdown-mac-darwin-amd64/...
6. 在文件 data/td2md.md 內查看最新結果

Markdown 轉註釋

下載地址：https://github.com/mazeyqian/go-gin-gee/releases/tag/v1.3.0

操作步驟：

1. 跟自身系統下載文件 convert-markdown-to-typedoc-mac-darwin-amd64/...
2. 在同個目錄下新建一個文件夾 data
3. 在文件夾 data 內新建一個文件 md2td.md
4. 在將需要被轉換的註釋放在文件 md2td.md
5. 執行 convert-markdown-to-typedoc-mac-darwin-amd64/...
6. 在文件 data/md2td.js 內查看最新結果

使用案例

GitHub：https://github.com/mazeyqian/mazey/tree/v3.7.4/scripts/convert

版權聲明

本博客所有的原創文章，作者皆保留版權。轉載必須包含本聲明，保持本文完整，並以超鏈接形式註明作者後除和本文原始地址：https://blog.mazey.net/3494.html