探讨为什么不应在示例代码中使用 TODO 占位注释

2026 年 11 月 5 日，DEV Community 的 AI 版块发表了一篇题为《探讨为什么不应在示例代码中使用 TODO 占位注释》的文章。文章指出，教程示例代码中的 TODO 占位注释会让开发者在复制使用时报立刻报错，尤其当不清楚需要填写什么内容时，这种体验令人沮丧。文中给出的例子是 `# TODO(developer): Uncomment and set your instance` 与 `instance_id = "your-instance-id"` 这样的占位内容，随后调用 `client = storage.Client(instance_id)`。

文章将这种写法称为 copy-paste-completable 模式，即作者写示例时本能地先留出占位符。随着 AI 助手和自动化 Agent 越来越普遍，这些占位符会被 AI 直接复制进生成的代码中，进一步放大问题。文章的建议是改用直接可运行或带安全默认值的写法。这是该事件目前唯一的报道，后续进展暂无公开信息。