快捷转换/互转 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

版权声明:本文版权归作者所有,遵循 CC 4.0 BY-SA 许可协议, 转载请注明原文链接
https://www.cnblogs.com/mazey/p/17436041.html

js中的undefined 与 null-编程思维

在 JavaScript 中, undefined 和 null 是两个特殊的值,用于表示缺失或空值。 undefined 是一个表示未定义或未赋值的原始值。它在以下情况下使用: 1. 变量声明了但未初始化时,默认为 undefined 。 let x; console.log(x); // undefine

web 前端常用正则校验规则-编程思维

Web 前端常用正则校验规则 作为 Web 前端开发,常用的正则校验规则有很多。下面是一些常见的示例: 1. 校验手机号码 手机号码的正则表达式可以根据不同国家和地区的手机号码格式进行调整。以下是中国大陆的手机号码正则表达式: const regex = /^1[3456789]\d{9}$/; 在这个示例中,正则表

javascript 格式化金额-编程思维

JavaScript 格式化金额 一、使用 Intl.NumberFormat 构造函数 这是 JavaScript 中格式化金额的最常见方法。Intl.NumberFormat()构造函数接受两个参数:语言环境和选项。语言环境是为其格式化金额的语言和地区。选项是一组控制金额格式的属性。例如,可以使用样式属性来指定货币

使用 vite 构建一个表情选择插件-编程思维

初始化 Vite 基于原生 ES 模块提供了丰富的内建功能,开箱即用。同时,插件足够简单,它不需要任何运行时依赖,只需要安装 vite (用于开发与构建)和 sass (用于开发环境编译 .scss 文件)。 npm i -D vite scss 项目配置 同时用 vite 开发插件和构建插件 demo,所以我创建了

我的前端技术栈-编程思维

前言 从事前端好几年,一直没有怎么总结。但是技术文章是一年比一年写的多了。在掘金看到了一位大佬写的文章,总结性非常的强,于是我差不多就仿了一篇。但是内容绝对不是一样的,文章中的链接是我自己写的技术文章。同时这份清单中也有我没有接触的一面,正好也是一份学习清单,我也是不定期的更新。最近正好给了自己闭关修炼的时间。所以我

tsconfig配置详解-编程思维

{ "compilerOptions": { /* Basic Options */ "target": "es5" /* target用于指定编译后js文件里的语法应该遵循哪个JavaScript的版本的版本目标: 'ES3' (default), 'ES5', 'ES2015', 'ES2016