经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » 程序设计 » 编程经验 » 查看文章
技术文档必备工具:注释目录树神器 Annotree,我的第一个正式开源项目
来源:cnblogs  作者:爱听书的程序员阿超  时间:2024/7/22 16:47:29  对本文有异议

hi,大家好,我是爱听书的程序员阿超
非常开心能在这里介绍我的第一个正式开源项目 Annotree,项目具体情况如下,请继续阅读??~

Annotree

Annotree 注释树

一款生成带注释的目录树工具,大大方便技术文档的编写

项目介绍 ??

本项目基于 folder-explorer 进行二次开发,感谢 FairyEver 的创意和贡献!

效果演示 ???

demo.gif

官方文档首页 ??

image.png

功能展示 ??

扫描

点击扫描按钮后打开文件选择器,选择需要扫描的文件夹,即可开始扫描。

20240713233436_rec_.gif

自动打开文件

导出文件后自动打开。

20240713233511_rec_.gif

忽略文件夹

忽略不需要扫描的文件夹,避免性能损失甚至程序失去响应,比如:node_modules 文件夹,程序内部已自动忽略 node_modules 文件夹。

20240713233557_rec_.gif

忽略以 "." 开头的文件夹

这类文件夹在 MacOS 和 Linux 上是默认隐藏的文件夹。

20240713235057_rec_.gif

只扫描文件夹

忽略所有文件,只扫描文件夹。

20240713233700_rec_.gif

忽略以 "." 开头的文件

这类文件在 MacOS 和 Linux 上是默认隐藏的文件。

20240713234828_rec_.gif

忽略文件类型

在扫描一次后,会生成此次扫描后的所有文件类型,可以选择忽略不需要的文件类型,以提高扫描效率。

20240713233809_rec_.gif

扫描深度

设置扫描目录的深度,0 为所有深度,每递增一个数字则代表扫描深度 +1。

20240713233922_rec_.gif

默认名称

导出文本的默认名称配置。

20240713234030_rec_.gif

注释格式化

填充注释的格式

20240713234450_rec_.gif

桥梁最短字符数

路径最长的地方,显示的桥梁字符数

20240713234351_rec_.gif

桥梁填充字符

输入一个单字节填充字符,比如:*,#,$,-,@,_ 等。

20240713234259_rec_.gif

始终显示桥梁

配置没有注释的地方是否显示桥梁。

20240713234200_rec_.gif

导出

设置好相关配置,编写好注释后,导出注释目录树。

20240713234122_rec_.gif

下载地址 ??

image.png

反馈渠道 ??

如果你有任何意见或建议,欢迎通过以下方式与我联系:

我为何选择飞书群作为社区沟通渠道:

  1. 我平时飞书用的较多,沟通方便。
  2. 飞书话题群沟通问题,效率更高。

开发 Annotree 的故事 ???

本项目基于 folder-explorer 进行二次开发,感谢 FairyEver 的创意和贡献!

起源

  • 2023 年 6 月,我负责搭建公司内部前端基础框架。框架搭建完成后,我希望通过注释来帮助团队成员快速理解目录结构。
  • 我发现 tree 命令可以扫描项目目录结构,但注释需要手动添加,不够便捷。
  • 之后发现了 folder-explorer,这个工具提供了目录注释和对齐功能,但仍不完全符合我的需求。
  • 为了解决上述问题,我基于 folder-explorer 进行了二次开发,创建了 Annotree。
  • 由于其他工作和对 Electron 不熟悉,直到 2024 年 7 月我才开始开发 Annotree。

为何二次开发

  1. folder-explorer 的部分功能对我而言冗余,不符合我的使用习惯。
  2. folder-explorer 导出文本后才看到效果,我希望有实时预览功能。
  3. folder-explorer 编辑备注需要右键打开菜单,操作不便。

期望 ??

  • 这是我做的第一个正式开源项目,大家的反馈和支持,对我很重要 ??,谢谢 ????
  • 现在项目还处于快速迭代中,期待大家的反馈与 pr,期待与大家一起共建更好的 Annotree ????

致谢 ????

  1. 感谢 electron-vite 提供的 electron 框架,大大提升我的开发效率。
  2. 感谢 md 提供给我的 README.md 文档思路。

谁在使用 ??

如果你使用了本 Annotree 工具生成带注释的项目文件树形结构,并且希望在本项目 README 中展示你的项目,请到 Discussions #2 留言。

原文链接:https://www.cnblogs.com/itchaox/p/18315704

 友情链接:直通硅谷  点职佳  北美留学生论坛

本站QQ群:前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

W3xue 的所有内容仅供测试,对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接(目前9元/月)请联系QQ:27243702 沸活量
皖ICP备17017327号-2 皖公网安备34020702000426号