You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何在PyCharm中添加不推送至Git仓库的代码注释或笔记?

实现本地专属注释/笔记的几种方法
  • 单独创建本地专属文件+Git忽略:
    可以新建一个或多个只在本地用的笔记文件,比如local-code-notes.md、utils-local-comments.js这类,然后在本地的.gitignore里添加这些文件名。注意别把修改后的.gitignore推送到仓库,要是怕手滑提交,能执行git update-index --assume-unchanged .gitignore,让Git暂时忽略对这个文件的改动,这样这些本地文件就不会被Git追踪,自然不会被推送。

  • 代码里加特殊标记+Git过滤:
    在代码里用特定前缀写本地注释,比如// LOCAL: 这里是我自己的理解,然后配置Git的clean过滤器,提交时自动删掉这类注释。步骤如下:

    1. 执行git config filter.local-notes.clean 'sed "/\/\/ LOCAL: /d"'定义过滤器
    2. 在本地的.git/info/attributes(这个文件本身就是本地专属,不会被提交)里添加规则,比如*.js filter=local-notes,这样提交代码时Git会自动移除带// LOCAL:的行,拉取代码时不影响,本地的注释只会留在自己的代码里。
  • 用IDE的本地注释功能:
    很多IDE自带或支持插件实现本地专属注释,不用修改代码文件。比如VS Code装个TODO Highlight插件,用自定义关键词(比如LOCAL_NOTE:)写注释,只有你能看到高亮提示;IntelliJ IDEA可以用Local Notes插件,给代码行添加本地笔记,这些内容只存在IDE的本地配置里,完全不会被Git追踪。

内容的提问来源于stack exchange,提问作者Busy Bee

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.08.05 11:50:21