用 HTML 标记的古怪代码注释
浏览:1217次 出处信息
现在我明白了,我在编程方面的很多做法都是古怪的、不入流的,不过,对我而言,多多少少是有帮助的。我的网站比大部分网站,肯定存在更多的问题,但是我交付的速度快了不少。你不都懂的。
我从来无法正确学到的一件事,就是注释我的代码。人们通常注释代码的方式如下:
上面的代码是从 PHP The Right Way 直接摘录的。我纠结的地方在于,代码缩进越深,代码就变得越发难以理解。如果你深入两个 foreach 循环,你该如何知道这部分代码起始何处?问题在于注释无法以某种方式来分割代码。你看不到某段代码的结尾。
你可以使用函数把代码简化为一行,这解决了很多问题。但是把每个小段代码弄成函数,也会减慢你的速度。
是否有一个折衷方案呢?
我受 HTML 的启发,其代码常常非常清晰,因为你能看到一个标签从哪儿开始、到哪儿结束。一目了然,下面是我相应做出的注释风格:
我在 PHP、JavaScript、Obj-C、甚至 Shell 脚本里使用这种注释风格,实际上对于我快速地搞清楚要编辑某个文件的哪个部分、以及其功能,让我节省了大量时间。
更有意思的是,如果你在用 Sublime Text,那么你还能折叠标签之间的整个代码,比如:
这可能违背了在 Hacker News 游荡的、留着大胡子的委员会编写的编码法则的宏大指导。不过还行,我没有留胡子。
原文地址(original source):https://levels.io/code-commenting/
作者(author):https://twitter.com/levelsio
建议继续学习:
- 提高代码可读性的注释技巧 (阅读:6627)
- 注释里的诅咒:哪种语言遭受最多的咒骂? (阅读:4391)
- 10个最“优秀”的代码注释 (阅读:3542)
- 如何进行更好的进行代码注释 (阅读:2350)
- 一个实例:为什么注释是愚蠢的 (阅读:2210)
- 10个最“牛叉”的代码注释 (阅读:1224)
QQ技术交流群:445447336,欢迎加入!
扫一扫订阅我的微信号:IT技术博客大学习
扫一扫订阅我的微信号:IT技术博客大学习
<< 前一篇:研发团队的角色和构成
后一篇:excel打开csv文件乱码的解决方法 >>
文章信息
- 作者:viviworld 来源: 腊八粥
- 标签: 注释
- 发布时间:2016-02-11 22:55:55
近3天十大热文
- [735] WEB系统需要关注的一些点
- [21] 移动音乐产品梳理
- [17] 豆瓣是啥?
- [16] 修改系统最大文件句柄数
- [16] 哪本书是对程序员最有影响、每个程序员都该阅读
- [15] 内存的惰性初始化
- [15] Spark性能优化——和shuffle搏斗
- [15] Chrome开发者工具的小技巧
- [14] 一张图帮你看懂 iPhone 的屏幕分辨率
- [12] sns视觉设计分享