讨论

注释为什么,而不是什么 - 代码注释提示词

来自 Wikiprompt,自由的提示词百科全书

Nas
贡献者NasX来源

2026年3月9日

注释为什么,而不是什么 - 代码注释提示词 用于生成代码注释的提示模板,这些注释解释代码背后的推理,而不仅仅是代码做了什么。

提示词内容收藏

🌐
不良代码注释(是什么):“// 排序列表” 良好代码注释(为什么):“// 按字母顺序排序,因为用户期望A-Z” 我的提示:“简短些” 他的风格:“控制在100字以内,因为移动用户会略读” 上下文 = 更好的执行。 老智慧:解释原因,而不是只给规则。

登录以查看完整提示词

继续使用:

登录即表示你同意我们的 使用条款 隐私政策

用法

此提示词专为 coding 设计。复制上方内容并粘贴到你常用的 AI 工具中。

为获得最佳效果,可将占位符(方括号或大写字母标示)替换为你的具体需求。

参考资料

分类:coding| twitter| code-comments| why-not-what

讨论