企业官网建设流程全解析

如何三步提升代码注释与代码文档质量：andrej-karpathy-skills 完整指南

【免费下载链接】andrej-karpathy-skillsA single CLAUDE.md file to improve Claude Code behavior, derived from Andrej Karpathy's 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：给验收标准上锁

• 输入：写好的注释。
• 动作：定一条可验证的验收标准，比如"新人照着注释能正确调用该函数"，然后循环修改到标准满足为止。
• 产出：一条经过验证、代码变更后不会立刻过期的注释。

误区对照：如何自动生成注释不踩坑

流程看着简单，差别在对比里才看得清。

左列全是"看起来完成了"的动作，右列都留了可检查的痕迹，这是两者最本质的分界。

10 分钟完成接入：两种方式怎么选 ⚡

按你的用法二选一，不用全上。

命令 A（在 Claude Code 内执行）：

/plugin marketplace add forrestchang/andrej-karpathy-skills /plugin install andrej-karpathy-skills@karpathy-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 Karpathy's observations on LLM coding pitfalls.项目地址: https://gitcode.com/GitHub_Trending/an/andrej-karpathy-skills