← 精品代码功能 · 可复用实现库
收录标准
判断一个代码实现是否值得进这个库。一条不满足就不收。
硬性门槛(必须全过)
- 独立:不依赖项目里的私有状态、全局单例、特定目录结构(或依赖很轻且说明清楚)
- 能跑:抽出来放到新项目里,稍作调整就能用;核心片段必须是真实可运行的代码
- 无秘密:不含 API Key、密码、个人隐私、公司业务数据
- 讲得清:能用两三句话说明"它解决什么问题"
加分项(越多越好)
| 维度 | 表现 |
|---|
| 职责单一 | 一个文件/函数只做一件事,边界清楚 |
| 有测试 | 自带单元测试,或原始来源经过实测(写清怎么测) |
| 覆盖边界 | 处理空值、异常、越界、编码等真实情况 |
| 注释讲"为什么" | 尤其记录"踩过的坑"(比如 paper-follower 那两段翻车注释) |
| 可移植 | 换语言/换平台成本低(纯函数最理想) |
| 有取舍说明 | 明确写出"为什么不选另一种方案" |
| 错误信息可操作 | 报错时告诉使用者下一步怎么做 |
明确不收录
- 炫技但脆:为了"显得高级"而牺牲可读性/可维护性
- 耦合深:它一跑,半个项目都得跟着搬
- 一次性:只适用于当前场景、无法迁移
- 有更好替代:标准库/成熟开源库已经做得更好(那就应该直接用别人的,而不是自己造)
- AI 生成的未验证代码:没经过运行验证的,一律不收
收录后的格式要求
每条按统一模板写:
# 精品功能 NN:名称
出处 / 一句话 / 解决什么问题
核心实现(代码)
设计亮点(3-5 条)
可复用性评估(依赖、移植难度、测试)
开源化建议(怎么抽成独立库/仓库)
对照开源
相关课程(第几课)
复审
- 原项目大改后,回来核对行号是否还准
- 发现更好的开源替代时,在条目里注明"其实可以用 XXX,但这里保留是为了讲原理"