用 HTML 标记的古怪代码注释
这篇讲的是作者如何从一个令他头疼的实际问题出发,为自己“定制”了一套代码注释方法。作者坦言自己一直无法掌握传统的注释方式,尤其是当代码嵌套层次变深后,注释无法清晰标记代码块的开始和结束,导致可读性反而下降。 为了解决这个痛点,他受HTML标签清晰界定范围的特性启发,创造了一种“古怪”的注释风格:在代码块的首尾添加类似``和``的注释。他声称在PHP、JavaScript、甚至Shell脚本中都使用这种方法。这不仅能让他在快速浏览文件时立刻定位到功能模块的边界,还意外获得了一个好处:在Sublime Text编辑器中,整个代码块可以像HTML标签一样被直接折叠起来,让视图更清爽。 作者知道这做法可能不符合某些严苛的编码规范,但他认为这种“小聪明”确实提升了自己定位和理解代码的效率。这篇文章的核心在于展现一个实用主义程序员如何为了实际工作流的顺畅,打破常规、对工具进行个性化改造的思路。