Annotree

Annotree 是一款生成带注释的目录树工具,旨在帮助用户高效地编写技术文档。它支持扫描文件夹、忽略特定文件或文件夹、设置扫描深度等功能,并能自定义注释格式和导出目录树。

Check out Annotree on CurateClick

• Copy the embed code to showcase this product on your website

• Share on X to spread the word about this amazing tool

项目介绍 🥳项目名称:Annotree项目简介:一款生成带注释的目录树工具GitHub 地址:https://github.com/itchaox/annotree官方文档:https://www.annotree.com使用场景:编写技术文档的目录注释树,帮助你高效地编写技术文档。> 这是我的第一个正式开源项目,如果对你有帮助,感谢 Star ⭐️ 和分享给你的朋友们,这对我很重要,谢谢 💖!### 效果演示:20240716092318_rec_### 官方文档首页:<img width="1512" alt="image" src="https://github.com/user-attachments/assets/8e36486d-8491-42ba-a629-069c90a4ffd2">## 功能展示 🤩### 扫描> 点击扫描按钮后打开文件选择器,选择需要扫描的文件夹,即可开始扫描。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