如何三步提升代码注释与代码文档质量andrej-karpathy-skills 完整指南【免费下载链接】andrej-karpathy-skillsA single CLAUDE.md file to improve Claude Code behavior, derived from Andrej Karpathys observations on LLM coding pitfalls.项目地址: https://gitcode.com/GitHub_Trending/an/andrej-karpathy-skills被 LLM 生成的一大堆废话注释搞晕过是不是注释越多代码文档反而越没法看andrej-karpathy-skills 是一套行为准则专治代码注释与代码文档的冗余和过时本文一次讲清用法。看清痛点注释越写越没用 上周让 LLM 给一个内部模块补文档注释产出是八十几行的文字墙。有的句子在复述函数名有的在解释一周前就删掉的实现细节最后一句还是这是一个重要函数。再打开代码文档满屏都是过期信息没人敢再动。是不是你也这样注释写了一堆回头一看全是废话认识这套 karpathy 编码原则它源自 Andrej Karpathy 对 LLM 写码坑点的观察最终浓缩成一个 CLAUDE.md 文件规则本体在 skills/karpathy-guidelines/SKILL.md。核心是四条原则先想再写、简单优先、最小改动、目标驱动。落到注释场景它不教你把句子写漂亮而是约束该写什么、写多少、写完拿什么验证正好对上废话注释、过期注释、过度包装这三类毛病。三步掌握 LLM 代码注释技巧 ️把最相关的三条原则翻译成一条流水线每步都按输入 → 动作 → 产出走可以直接照做。Step 1 · Think Before Coding先钉死为什么写输入待文档化的代码段加上你当前的理解。动作先回答三个问题——这条注释写给谁看、解决什么疑惑、你自己哪里还没想清楚卡住就先说卡住别硬编。产出一句能直接当注释头部的用途与边界说明。Step 2 · Simplicity First删掉一切不必须的输入第一版注释。动作逐句自问这行存在的理由是什么答不上来就删三行能压成一行就压。产出只保留用途、关键参数、副作用的轻量注释。Step 3 · Goal-Driven Execution给验收标准上锁输入写好的注释。动作定一条可验证的验收标准比如新人照着注释能正确调用该函数然后循环修改到标准满足为止。产出一条经过验证、代码变更后不会立刻过期的注释。误区对照如何自动生成注释不踩坑流程看着简单差别在对比里才看得清。场景常见错误做法建议做法给函数写文档逐字复述函数名和参数列表写清楚它为什么存在、前置条件、失败后果改动已有代码LLM 顺手优化相邻的旧注释只碰本次改动直接涉及的注释其余原样保留任务收尾报一句注释已添加就算完附上可验证标准如新人照注释能跑通该模块左列全是看起来完成了的动作右列都留了可检查的痕迹这是两者最本质的分界。10 分钟完成接入两种方式怎么选 ⚡按你的用法二选一不用全上。方式适用场景命令备注Claude Code 插件所有项目全局生效一次配置命令 A官方推荐装完到处可用CLAUDE.md 追加只在单个项目精细控制命令 B可与你已有的规则文件合并命令 A在 Claude Code 内执行/plugin marketplace add forrestchang/andrej-karpathy-skills /plugin install andrej-karpathy-skillskarpathy-skills命令 B单个项目新旧项目都适用git clone https://gitcode.com/GitHub_Trending/an/andrej-karpathy-skills cat andrej-karpathy-skills/CLAUDE.md CLAUDE.md项目细节和取舍说明在 README.md 里都能找到改错别字这类小事可以跳过整套流程这套准则本来就不是为小事准备的。今天就动手挑个模块试一遍挑一个注释最烂的模块按上面三步让 LLM 重写一版再用 Step 3 的验收标准逐条检查。跑通一次你就再回不去废话注释的时代了。【免费下载链接】andrej-karpathy-skillsA single CLAUDE.md file to improve Claude Code behavior, derived from Andrej Karpathys observations on LLM coding pitfalls.项目地址: https://gitcode.com/GitHub_Trending/an/andrej-karpathy-skills创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 如何三步提升代码注释与代码文档质量：andrej-karpathy-skills 完整指南
如何三步提升代码注释与代码文档质量andrej-karpathy-skills 完整指南【免费下载链接】andrej-karpathy-skillsA single CLAUDE.md file to improve Claude Code behavior, derived from Andrej Karpathys observations on LLM coding pitfalls.项目地址: https://gitcode.com/GitHub_Trending/an/andrej-karpathy-skills被 LLM 生成的一大堆废话注释搞晕过是不是注释越多代码文档反而越没法看andrej-karpathy-skills 是一套行为准则专治代码注释与代码文档的冗余和过时本文一次讲清用法。看清痛点注释越写越没用 上周让 LLM 给一个内部模块补文档注释产出是八十几行的文字墙。有的句子在复述函数名有的在解释一周前就删掉的实现细节最后一句还是这是一个重要函数。再打开代码文档满屏都是过期信息没人敢再动。是不是你也这样注释写了一堆回头一看全是废话认识这套 karpathy 编码原则它源自 Andrej Karpathy 对 LLM 写码坑点的观察最终浓缩成一个 CLAUDE.md 文件规则本体在 skills/karpathy-guidelines/SKILL.md。核心是四条原则先想再写、简单优先、最小改动、目标驱动。落到注释场景它不教你把句子写漂亮而是约束该写什么、写多少、写完拿什么验证正好对上废话注释、过期注释、过度包装这三类毛病。三步掌握 LLM 代码注释技巧 ️把最相关的三条原则翻译成一条流水线每步都按输入 → 动作 → 产出走可以直接照做。Step 1 · Think Before Coding先钉死为什么写输入待文档化的代码段加上你当前的理解。动作先回答三个问题——这条注释写给谁看、解决什么疑惑、你自己哪里还没想清楚卡住就先说卡住别硬编。产出一句能直接当注释头部的用途与边界说明。Step 2 · Simplicity First删掉一切不必须的输入第一版注释。动作逐句自问这行存在的理由是什么答不上来就删三行能压成一行就压。产出只保留用途、关键参数、副作用的轻量注释。Step 3 · Goal-Driven Execution给验收标准上锁输入写好的注释。动作定一条可验证的验收标准比如新人照着注释能正确调用该函数然后循环修改到标准满足为止。产出一条经过验证、代码变更后不会立刻过期的注释。误区对照如何自动生成注释不踩坑流程看着简单差别在对比里才看得清。场景常见错误做法建议做法给函数写文档逐字复述函数名和参数列表写清楚它为什么存在、前置条件、失败后果改动已有代码LLM 顺手优化相邻的旧注释只碰本次改动直接涉及的注释其余原样保留任务收尾报一句注释已添加就算完附上可验证标准如新人照注释能跑通该模块左列全是看起来完成了的动作右列都留了可检查的痕迹这是两者最本质的分界。10 分钟完成接入两种方式怎么选 ⚡按你的用法二选一不用全上。方式适用场景命令备注Claude Code 插件所有项目全局生效一次配置命令 A官方推荐装完到处可用CLAUDE.md 追加只在单个项目精细控制命令 B可与你已有的规则文件合并命令 A在 Claude Code 内执行/plugin marketplace add forrestchang/andrej-karpathy-skills /plugin install andrej-karpathy-skillskarpathy-skills命令 B单个项目新旧项目都适用git clone https://gitcode.com/GitHub_Trending/an/andrej-karpathy-skills cat andrej-karpathy-skills/CLAUDE.md CLAUDE.md项目细节和取舍说明在 README.md 里都能找到改错别字这类小事可以跳过整套流程这套准则本来就不是为小事准备的。今天就动手挑个模块试一遍挑一个注释最烂的模块按上面三步让 LLM 重写一版再用 Step 3 的验收标准逐条检查。跑通一次你就再回不去废话注释的时代了。【免费下载链接】andrej-karpathy-skillsA single CLAUDE.md file to improve Claude Code behavior, derived from Andrej Karpathys observations on LLM coding pitfalls.项目地址: https://gitcode.com/GitHub_Trending/an/andrej-karpathy-skills创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考