重新思考代码注释

Justin Duke 提出一个巧妙的想法：将代码注释视为脚注，能否帮助我们更好地理解代码文件？在他的设计原型中，所有注释默认隐藏，需要点击才能显示。

这个主意真棒！Justin 的设计让我想起了 Instapaper 处理内联脚注的方式。

我如此喜欢这个想法的原因可能是，许多注释不需要经常阅读——它们更像是一种提醒，“嘿，这将来需要改进”或“哎呀，这很奇怪，我很抱歉”。将这些注释从代码中移除，也使扫描整个文件更容易得多。

我很好奇是否可以添加一个切换按钮，显示所有注释，以防您需要按顺序阅读所有注释，而不是逐个点击切换。

总之，所有关于注释的讨论让我想起了 Sarah Drasner 今年在 JSConf 上发表的一次精彩演讲，她在演讲中讨论了为什么注释如此难以写好：

以上是重新思考代码注释的详细内容。更多信息请关注PHP中文网其他相关文章！