跟随系统
浅色模式
深色模式
打赏站长

vscode给文件及文件夹设置备注的插件为自己开发的插件

实用工具
预计阅读 5分钟
2023-12-19
返回博客

👻 一个给文件及文件夹设置备注的插件 👻

前言-(废话)

在我的日常开发中经常会遇到一些棘手的项目名称,比如【稳进提质】【浙省事】【新湘事成】这些“究极简写”及“谐音梗”。

给这些文件或文件夹起名英文文件名无疑是🤣 画上的马——顶看不顶用 😅。起拼音名,当时是能看懂了,过一段时间:“阿巴阿巴,啥呀,这是”。

也有一段时间把文件名的备注啥的以树形的结构写在 Readme.md 里面,当时看起来“嗯···挺好”,一旦有一些急事过来,临时更改或者怎么样,就会忘记更新,后面再去更新就没了头绪,理起来也很费时间,😑 费心情!😒

🎉🎉🎉 于是诞生了这个小插件 🎉🎉🎉

下载地址,点击跳转安装

或在 vscode 内搜索备注Super File Notes都可以。找到名为Super File Notes的插件,安装即可。

🧧 打赏作者 🧧

点击链接尽情打赏我把!https://xiaoxiaoyang.top/?donate=true

这个也是作者的博客,里面也有很多开发的其他工具、插件推荐、干活分享、技术分享哦~
创作不易,请支持原创!

插件特点-(使用方法)

✨给文件及文件夹设置 备注 ,显示在资源管理器的 文件名右侧 。

✨--- vssmall 限制显示两个字符,移动到文件上会显示全部

✨支持快捷键 ctrl + M 快捷添加备注。

✨--- 快捷键支持在 键盘快捷方式 中自定义(删除备注使用快捷键容易误触产生不可逆操作,故未设置快捷键)

✨支持查看单条备注

✨支持一键查看所有备注

✨支持 文件 文件夹 重命名后同步备注

✨支持 文件 文件夹 移动位置后同步备注

✨推荐在 .gitignore 文件中把 .vssmall 文件夹取消忽略提交,这样在多人协同项目时,都可以看到文件备注。

✨使用方法看图 图片查看不了?

 image.png

注意事项

  • 💀使用 windows 文件管理器 / mac访达(而非VSsmall)进行文件移动,这种情况下 VSsmall 事件无法捕捉到,会导致备注失效。So:请尽量在 vscode 内操作文件。

已知问题

  • 💀文件夹在特定场景下备注不会显示

    Q: 如果文件夹内的文件包含未提交的文件 或其中有文件存在错误(git) vssmall会提示 包含强调项 ,由于该提示权限较高,无法更改,暂时没有找到理想的解决办法                               
    A:可 右击查看备注 或 git提交修改后 即可正常显示。 

    image1.png

其他

  • 备注的数据存储在/.vssmall/file-notes.json 中

  • 手动更改 file-notes.json 需重启vssmall 才能生效