背景
作为文档工具人,经常需要把代码里面的注释转换成语义化的 Markdown 文档,有时也需要进行反向操作。以前是写正则表达式全局匹配,时间长了这种方式也变得繁琐乏味。所以写了脚本来互转,增加一些便捷性。
解决方案
注释转 Markdown
下载地址:https://github.com/mazeyqian/go-gin-gee/releases/tag/v1.2.0
操作步骤:
- 跟自身系统下载文件
convert-typedoc-to-markdown-mac-darwin-amd64
/… - 在同个目录下新建一个文件夹
data
- 在文件夹
data
内新建一个文件td2md.js
- 在将需要被转换的注释放在文件
td2md.js
- 执行
convert-typedoc-to-markdown-mac-darwin-amd64
/… - 在文件
data/td2md.md
内查看最新结果
Markdown 转注释
下载地址:https://github.com/mazeyqian/go-gin-gee/releases/tag/v1.3.0
操作步骤:
- 跟自身系统下载文件
convert-markdown-to-typedoc-mac-darwin-amd64
/… - 在同个目录下新建一个文件夹
data
- 在文件夹
data
内新建一个文件md2td.md
- 在将需要被转换的注释放在文件
md2td.md
- 执行
convert-markdown-to-typedoc-mac-darwin-amd64
/… - 在文件
data/md2td.js
内查看最新结果
使用案例
GitHub:https://github.com/mazeyqian/mazey/tree/v3.7.4/scripts/convert
版权声明
本博客所有的原创文章,作者皆保留版权。转载必须包含本声明,保持本文完整,并以超链接形式注明作者后除和本文原始地址:https://blog.mazey.net/3494.html
服务器托管,北京服务器托管,服务器租用 http://www.fwqtg.net
相关推荐: 【惯性导航】隧道、高架桥、高楼林立弱信号环境室外定位_惯导模块
汽车行驶在路上,视野可能会受到周边的树木、同行的卡车、城市楼群的遮挡,卫星导航系统容易受到周围环境的影响,例如树木楼房等,造成多路径效应,使得定位结果精度降低甚至丢失,尤其是在隧道或者室内环境中,卫星导航系统基本无法使用。为完善汽车在弱信号环境下卫星定位无法提…