前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >快捷转换/互转 Markdown 文档和 TypeScript/TypeDoc 注释

快捷转换/互转 Markdown 文档和 TypeScript/TypeDoc 注释

原创
作者头像
后除
发布2023-05-26 22:53:35
2370
发布2023-05-26 22:53:35
举报
文章被收录于专栏:后除的专栏后除的专栏

背景

作为文档工具人,经常需要把代码里面的注释转换成语义化的 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 内查看最新结果
Convert TypeDoc to Markdown
Convert TypeDoc to Markdown

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 内查看最新结果
Convert Markdown to TypeDoc
Convert Markdown to TypeDoc

使用案例

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

GitHub Case
GitHub Case

版权声明

本博客所有的原创文章,作者皆保留版权。转载必须包含本声明,保持本文完整,并以超链接形式注明作者后除和本文原始地址:https://blog.mazey.net/3494.html

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 背景
  • 解决方案
    • 注释转 Markdown
      • Markdown 转注释
      • 使用案例
      领券
      问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档


      http://www.vxiaotou.com