git-note

基于Git的临时注释扩展。

动机

当你加入一家新公司，适应工作空间，并首次打开项目时，你会面对一片令人眼花缭乱的代码。作为一名熟练掌握各种编程语言的职业程序员，你拥有深入分析代码的技能。然而，即使是专家也可能暂时被特定领域的术语所困惑。理解代码的功能是一回事，但保留所有这些细节以构建对系统工作方式的全面视图则是另一回事。

你可以尝试在文本编辑器或其他地方写下笔记，但通常很难将这些笔记与你对系统架构的整体理解联系起来。或者，你也可以尝试直接在代码中添加注释，但这种做法并不总是可行。例如，你可能在遵循严格编码准则的项目中工作，该准则禁止在代码库中包含个人笔记。或者，你可能在大型团队的项目中工作，将个人笔记添加到代码库可能会导致混淆或误解。

这就是git-note发挥作用的地方——一个工具，允许你直接记录与代码直接相关的见解、注释或笔记，同时将它们隐藏在源代码本身之外。这些注释仅对你可见，可以无缝集成到你的IDE中，使你在代码的上下文中轻松查看你的注释变得轻而易举。

安装

• 目前，git-note可以通过从IntelliJ插件使用最新版本直接安装。请注意，这是一个beta版本，我正在积极改进和添加新功能。在beta测试阶段完成后，我们计划将git-note发布到JetBrains插件市场以方便访问。

• 目前，git-note仅支持 Apple Silicon Mac。然而，我致力于将我们的支持扩展到其他平台，包括Windows、Intel macOS和Linux。

• 从长远来看，我们还计划开发一个Visual Studio Code插件。这是一个重大的项目，因此欢迎社区贡献以帮助将其变为现实。