网管联盟 | 网管论坛 | 网管u家 | 网管博客 | 网管软件 | 网管求职 | 小游戏 | 网管搜索 | 网管原创 | 网管聚合 | 网管读摘 | 网管焦点 | 世界素材 | 会员投稿 | 会员中心 
中国网管联盟
Windows Linux Cisco 网络技术 数据库 黑客攻防 DotNet Java PHP 认证 新闻资讯 服务器 存储资讯 网络设备 网管学堂 技术专题 焦点 网吧频道
 当前位置: > bitsCN.com > 网管学堂 > 网页设计 > Flash > 基础教程 > 关于脚本中注释的五点建议  

关于脚本中注释的五点建议

2006-05-12  作者:中国网管联盟  来源:BitsCN.com整理  点评 投稿 收藏

当你学习某代码技术已经基本入门以后,自然会注意到提高代码质量的重要性,而书写注释则是提高代码质量的第一关——可能也是最容易的一关。以下是我总结的关于书写注释的一些建议!

  一、切勿为了注释而注释!

  为代码添加注释的最主要目的是提高代码可读性,但这里面还有一个心态问题:如果你认为,写了注释,就可以提高代码质量,就可以证明实力,那就错了,事情并没有那么简单。

  相信一定有人在写注释的时候,没有把握正确的心态,这就导致写出来的注释往往不合时宜。什么是不合时宜的注释?我就写过这样的注释:

  ……
  '打开记录集,记录Orders表所有数据
  objRS.Open "SELECT * FROM Orders",objConn,1,1
  ……
  objRS.Close '关闭记录集
  Set objRS=Nothing '释放记录集对象
  ……

  明白了吧?这就是不合时宜的注释的情形之一:形式化的注释,往往会成为代码的累赘,甚至无法突出真正需要注释的地方,降低了代码的可读性。

  这都是心态没有把握好的原因。如果能正确把握心态,就会把心思放到提高代码可读性上,而不是放到写注释上了!写注释只是提高代码可读性的手段之一,而且写注释也是要讲技巧和效率的。

TAGs   建议   注释   脚本   关于   代码   提高   心态   记录   不合时宜   质量      
 上一篇:flash8.0笔触颜色支持什么   下一篇:进阶:Flash 8 少为人知的特性!
关于脚本中注释的五点建议 评论:
loading.. 评论加载中…
评论:请自觉遵守互联网相关政策法规,评论不得超过250字。

验证码: 注册用户
本类热门排行:
最新推荐文章:
网管论坛交流: