用 HTML 标记的古怪代码注释
教程管理员 发布于2023-09-27 06:35 HTML教程 141
现在我明白了,我在编程方面的很多做法都是古怪的、不入流的,不过,对我而言,多多少少是有帮助的。我的网站比大部分网站,肯定存在更多的问题,但是我交付的速度快了不少。你不都懂的。
我从来无法正确学到的一件事,就是注释我的代码。人们通常注释代码的方式如下:
PHP The Right Way 的代码摘录
上面的代码是从 PHP The Right Way 直接摘录的。我纠结的地方在于,代码缩进越深,代码就变得越发难以理解。如果你深入两个 foreach 循环,你该如何知道这部分代码起始何处?问题在于注释无法以某种方式来分割代码。你看不到某段代码的结尾。
你可以使用函数把代码简化为一行,这解决了很多问题。但是把每个小段代码弄成函数,也会减慢你的速度。
是否有一个折衷方案呢?
我受 HTML 的启发,其代码常常非常清晰,因为你能看到一个标签从哪儿开始、到哪儿结束。一目了然,下面是我相应做出的注释风格:
HTML 标记风格的代码注释
我在 PHP、JavaScript、Obj-C、甚至 Shell 脚本里使用这种注释风格,实际上对于我快速地搞清楚要编辑某个文件的哪个部分、以及其功能,让我节省了大量时间。
更有意思的是,如果你在用 Sublime Text,那么你还能折叠标签之间的整个代码,比如:
在Sublime Text 可折叠的HTML 标记风格的代码注释
这可能违背了在 Hacker News 游荡的、留着大胡子的委员会编写的编码法则的宏大指导。不过还行,我没有留胡子。
本文来自云栖社区合作伙伴“Linux中国”,原文发布日期:2015-09-14
相关推荐
- 10-04 在HTML中取得请求中的参数
- 10-04 SharePoint 2013 母版页取消和HTML页关联
- 10-04 29行代码使用HTML5 Canvas API绘制一颗红心
- 10-04 浏览器加载和渲染html的顺序,Div和Table的区别
- 10-04 《HTML5完美游戏开发》——2.6 Processing.js实例和整合
- 10-04 如何关闭Struts2的webconsole.html
- 10-04 《HTML5 开发实例大全》——1.4 使用CSS修饰HTML 5页面
- 10-04 《HTML5游戏编程核心技术与实战》——2.8 小结
- 10-04 腾讯视频生成的Html代码
- 10-04 ie下tbody的innerhtml属性只读
- 控制面板
- 友情链接
- 最近发表
-
- 涂鸦而不乱简约艺术主题Office PPT免费模板背景素材下载
- 有创意的情人表白动态贺卡Office PPT免费模板背景素材下载
- 绿色简约技能竞赛电力Office PPT免费模板背景素材下载
- 极简几何商务蓝年终总结汇报Office PPT免费模板背景素材下载
- 蓝橙简约商务年终总结汇报Office PPT免费模板背景素材下载
- 绿色清新教育风课堂教学通用Office PPT免费模板背景素材下载
- 潮流复古艺术感年终总结Office PPT免费模板背景素材下载
- 浅绿商务风工作总结报告Office PPT免费模板背景素材下载
- 大气简约时尚年终总结汇报Office PPT免费模板背景素材下载
- 喜庆春节风公司年终誓师表彰大会Office PPT免费模板背景素材下载
- 最新留言
-