重新思考代码注释

Avatar of Robin Rendle
Robin Rendle

DigitalOcean 为您旅程的每个阶段提供云产品。立即开始使用 $200 免费积分!

Justin Duke 询问是否将 代码注释视为脚注 可以帮助我们更好地理解文件中的代码。在他的模拟中,所有注释默认情况下都是隐藏的,需要点击才能显示

真是个好主意!Justin 的设计让我想起了 Instapaper 处理内联脚注的方式。

Instapaper(大约 2012 年)

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

我很好奇是否可以有一个开关显示所有注释,以防您需要按顺序阅读所有注释,而不是点击切换每个注释。

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