首页
/ 编程新甜点: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 带来的不仅仅是代码的美化,更是效率的提升。现在就尝试加入这个甜美的编程世界,让编程体验更上一层楼吧!

登录后查看全文

项目优选

收起
kernelkernel
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
514
555
docsdocs
暂无描述
Markdown
858
5.71 K
ops-transformerops-transformer
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。
C++
1.05 K
2.52 K
ops-nnops-nn
本项目是CANN提供的神经网络类计算算子库,实现网络在NPU上加速计算。
C++
852
1.72 K
pytorchpytorch
作为 Ascend for PyTorch 社区的核心组件,TorchNPU 是昇腾专为 PyTorch 打造的深度学习适配插件,使 PyTorch 框架能够直接调用昇腾 NPU,为开发者提供昇腾 AI 处理器的超强算力。
Python
841
1.29 K
jiuwenswarmjiuwenswarm
JiuwenSwarm 是一款基于openJiuwen开发的智能AI Agent,它能够将大语言模型的强大能力,通过你日常使用的各类通讯应用,直接延伸至你的指尖。
Python
3.36 K
869
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
1.25 K
1.38 K
AscendNPU-IRAscendNPU-IR
AscendNPU-IR是基于MLIR(Multi-Level Intermediate Representation)构建的,面向昇腾亲和算子编译时使用的中间表示,提供昇腾完备表达能力,通过编译优化提升昇腾AI处理器计算效率,支持通过生态框架使能昇腾AI处理器与深度调优
C++
513
349
kernelkernel
deepin linux kernel
C
33
16
flutter_flutterflutter_flutter
本仓库是 Flutter SDK 与 Flutter Engine 的 OpenHarmony 适配版本,由 CPF-Flutter 团队维护。开发者可使用熟悉的 Flutter 技术栈开发 OpenHarmony 应用,3.35.7 及以后的适配版本可基于本仓库源码构建支持 OpenHarmony 的 Flutter Engine。
Dart
1.14 K
320