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

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

2024-05-30 15:32:25作者:庞眉杨Will

在编程的世界里,有时候我们需要一些甜蜜的小点缀来提升效率。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 带来的不仅仅是代码的美化,更是效率的提升。现在就尝试加入这个甜美的编程世界,让编程体验更上一层楼吧!

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8