如何为GitHub上的Python项目代码添加注释辅助学习？

以下方案均不会干扰你正常拉取、克隆原项目，也不会修改原仓库的代码结构：

方案1：本地专属学习分支 #

• 克隆项目后先执行git checkout -b my-learning新建独立的本地学习分支
• 直接在该分支的源码上添加你的注释，所有修改仅保留在本地学习分支中
• 需要拉取原项目更新时，先切回原项目默认分支拉取最新代码，再执行git merge 原默认分支名 my-learning将更新同步到你的学习分支即可，完全不需要重复克隆项目

方案2：独立注释映射文件（完全不碰源码） #

• 在项目根目录新建learn_notes文件夹，将/learn_notes写入项目的.gitignore文件中，Git会完全忽略该文件夹的所有内容
• 每个源码文件对应一个同名注释文件，比如原文件为core/model.py，你可以新建learn_notes/core/model.py.md存储注释，按行号对应写你的理解即可，示例：

第17-24行：初始化模型骨干网络，默认加载ImageNet预训练权重，传入参数pretrained=False可改为随机初始化

• 该方式完全不修改原源码，即使你删除本地仓库重新克隆，只要提前备份好learn_notes文件夹，放回新项目根目录就能继续使用

方案3：IDE行级临时注释插件 #

• 主流Python IDE（PyCharm、VS Code）均支持不修改源码的行级笔记插件，所有注释内容存储在IDE本地配置目录中，和源码完全分离
• 打开对应代码行添加注释即可，无论你拉取更新还是重新克隆项目，只要IDE识别到该项目路径，之前添加的注释会自动匹配对应代码行显示

内容的提问来源于stack exchange，提问作者Nephophile