首页
/ 编程新甜点:Nvim-Biscuits——代码注释的美味小饼干

编程新甜点:Nvim-Biscuits——代码注释的美味小饼干

2024-05-30 15:32:25作者:庞眉杨Will
nvim-biscuits
A neovim port of Assorted Biscuits. Ends up with more supported languages too.

在编程的世界里,有时候我们需要一些甜蜜的小点缀来提升效率。Nvim-Biscuits就是这样一款新颖的开源插件,它为你的代码添加了“饼干”式的注解,帮助你快速理解代码结构,避免在庞大的AST节点中迷失方向。

项目简介

Nvim-Biscuits 是一个专为 Neovim 设计的插件,它利用 nvim-treesitter 的语法解析能力,在闭合标签、括号等处添加可视化提示。这些“饼干”注释就像小小的路标,让你在代码间游走时更加得心应手。

Nvim-Biscuits 动态演示

技术剖析

Nvim-Biscuits 基于树坐标的解析器(tree-sitter)工作,它可以理解和解析多种编程语言的语法结构。当你在代码行之间移动光标时,插件会在适当的地方显示简洁的注解,这些注解可以是预先定义的字符串,如 “;/*” 或者自定义的符号,例如 “自查”。

安装依赖后,只需简单的配置即可启用 Nvim-Biscuits:

call plug#begin()
Plug 'nvim-treesitter/nvim-treesitter', {'do': ':TSUpdate'}
Plug 'code-biscuits/nvim-biscuits'
call plug#end()

lua require'nvim-treesitter.configs'.setup {
  ensure_installed = "maintained",
  ...
}
lua require('nvim-biscuits').setup({})

应用场景

  • 代码导航:在HTML、CSS、JavaScript或任何其他支持的语言中,当你的光标位于闭合标签之外时,“饼干”会告诉你这个元素的作用范围。
  • 团队协作:对于多人协作的大型项目,一致的注解风格可以使代码更具可读性。
  • 个人开发:个人开发时,特别是在处理复杂嵌套结构时,Nvim-Biscuits 可以提高理解和修改代码的速度。

项目特点

  1. 跨语言支持:支持所有树坐标的解析语言,包括Go、Python、JavaScript、Rust等等。
  2. 高度定制:你可以根据自己的喜好和需求调整“饼干”的前缀、长度、颜色,甚至是否显示特定语言的注解。
  3. 动态更新:“饼干”会随你的输入实时更新,无需手动刷新。
  4. 智能开关:可以通过键绑定轻松地隐藏或显示“饼干”,并且可以在启动时选择是否默认显示。
  5. 优化性能:有选项只在当前光标行显示注解,避免屏幕过载。

Nvim-Biscuits 带来的不仅仅是代码的美化,更是效率的提升。现在就尝试加入这个甜美的编程世界,让编程体验更上一层楼吧!

nvim-biscuits
A neovim port of Assorted Biscuits. Ends up with more supported languages too.
热门项目推荐
相关项目推荐

项目优选

收起
CangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
669
0
RuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
136
18
openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
10
4
redis-sdk
仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。
Cangjie
322
26
advanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
75.83 K
19.04 K
qwerty-learner
为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers
TSX
15.56 K
1.44 K
Jpom
🚀简而轻的低侵入式在线构建、自动部署、日常运维、项目监控软件
Java
1.41 K
292
Yi-Coder
Yi Coder 编程模型,小而强大的编程助手
HTML
30
5
easy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
1.42 K
231
taro
开放式跨端跨框架解决方案,支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。 https://taro.zone/
TypeScript
35.34 K
4.77 K