📖 摸鱼看书神器
一个让你在写代码时优雅摸鱼的 VSCode 插件！当光标在注释行时，小说内容会显示在注释后面，完美伪装。
✨ 核心特性
- 📝 光标触发：只在光标所在的注释行显示小说
- ⌨️ 快捷键控制：快速显示/隐藏、翻页
- ⚙️ 灵活配置：自定义小说路径、每页长度、显示样式
- 💾 记忆功能：自动保存阅读进度
- 🎭 完美伪装：老板来了按
Cmd+M 立即隐藏
🚀 快速开始
1. 准备小说文件
创建一个 TXT 文件（UTF-8 编码），例如：
第一章：标题
正文内容...
项目包含示例文件：example-novel.txt
2. 配置路径
打开 VSCode 设置，搜索 "book-zhushi"，设置小说路径：
- Mac:
/Users/yourname/Desktop/novel.txt
- Windows:
C:\Users\yourname\Desktop\novel.txt
3. 开始使用
- 在代码中写注释（
// 或 # 开头）
- 光标放在注释行
- 按
Cmd+M (Mac) 或 Ctrl+Alt+M (Windows)
- 小说出现在注释后面！
⌨️ 快捷键
MAC
Cmd+M - 显示/隐藏小说（老板键）Cmd+. - 下一页Cmd+, - 上一页Cmd+; - 跳转到指定页
Windows/Linux
Ctrl+Alt+M - 显示/隐藏小说Ctrl+Alt+. - 下一页Ctrl+Alt+, - 上一页Ctrl+Alt+; - 跳转到指定页
⚙️ 配置项
| 配置项 |
默认值 |
说明 |
novelPath |
空 |
小说 TXT 文件路径（绝对路径） |
pageLength |
50 |
每页字符数 |
isEnglish |
false |
是否为英文小说 |
separator |
空 |
换行分隔符（空=无缝连接） |
textColor |
#888888 |
文字颜色 |
fontStyle |
italic |
字体样式（normal/italic/oblique） |
💡 使用示例
// 审查这个函数 📖 第一章：修仙从摸鱼开始。李明是一名普通的程序员...
function review() {
// 光标在这 📖 直到有一天，他发现了一个神奇的插件...
return true;
}
🎨 效果对比
未显示：
// 这是一个注释
显示后（光标在注释行）：
// 这是一个注释 📖 第一章：修仙从摸鱼开始。李明是一名普通的程序员，每天朝九晚九...
📝 支持的注释格式
- JavaScript/TypeScript:
//
- Python:
#
- CSS/C++:
/* 或 *
- HTML:
<!--
🔧 开发调试
# 安装依赖
npm install
# 编译
npm run compile
# 启动调试（按 F5）
# 会打开新窗口进行测试
📦 打包安装
# 安装打包工具
npm install -g @vscode/vsce
# 打包
vsce package
# 安装 .vsix 文件
# VSCode 命令面板 -> "Install from VSIX"
🐛 常见问题
Q: 看不到小说？
- 确保光标在注释行
- 检查是否按了
Cmd+M 显示
- 验证小说路径是否正确
Q: 快捷键冲突？
- 在
package.json 中修改 keybindings
Q: 如何更换小说？
⚠️ 注意事项
- 本插件仅供学习和娱乐
- 请合理安排工作时间
- 适度摸鱼，快乐工作 😄
📄 许可证
MIT
详细文档: 查看 新版使用说明.md
| |
