十大注释技巧教你如何书写容易阅读的代码

发布时间:2012-11-21 20:26    发布者:1770309616
关键词: 编程 , 程序代码
  很多程序员在写代码的时候往往都不注意代码的可读性,让别人在阅读代码时花费更多的时间。其实,只要程序员在写代码的时候,注意为代码加注释,并以合理的格式为代码加注释,这样就方便别人查看代码,也方便自己以后查看了。下面分享十个加注释的技巧:
  1. 逐层注释
  为每个代码块添加注释,并在每一层使用统一的注释方法和风格。例如:
  针对每个类:包括摘要信息、作者信息、以及最近修改日期等;
  针对每个方法:包括用途、功能、参数和返回值等。
  在团队工作中,采用标准化的注释尤为重要。当然,使用注释规范和工具(例如C#里的XML,Java里的Javadoc)可以更好的推动注释工作完成得更好。
  2. 使用分段注释
  如果有多个代码块,而每个代码块完成一个单一任务,则在每个代码块前添加一个注释来向读者说明这段代码的功能。例子如下:
  // Check that all data records
  // are correct
  foreach (Record record in records)
  {
  if (rec.checkStatus()==Status.OK)
  {
  . . .
  }
  }
  // Now we begin to perform
  // transactions
  Context ctx = new ApplicationContext();
  ctx.BeginTransaction();
  3. 在代码行后添加注释
  如果多行代码的每行都要添加注释,则在每行代码后添加该行的注释,这将很容易理解。例如:
  const MAX_ITEMS = 10; // maximum number of packets
  const MASK = 0x1F; // mask bit TCP
  在分隔代码和注释时,有的开发者使用tab键,而另一些则使用空格键。然而由于tab键在各编辑器和IDE工具之间的表现不一致,因此最好的方法还是使用空格键。
  4. 不要侮辱读者的智慧
  避免以下显而易见的注释:写这些无用的注释会浪费你的时间,并将转移读者对该代码细节的理解。
  if (a == 5) // if a equals 5
  counter = 0; // set the counter to zero
  website = "http://www.xxx.net.cn"; // this is a website
  5. 礼貌点
  避免粗鲁的注释,如:“注意,愚蠢的使用者才会输入一个负数”或“刚修复的这个问题出于最初的无能开发者之手”。这样的注释能够反映到它的作者是多么的拙劣,你也永远不知道谁将会阅读这些注释,可能是:你的老板,客户,或者是你刚才侮辱过的无能开发者。
  6. 关注要点
  不要写过多的需要转意且不易理解的注释。避免ASCII艺术,搞笑,诗情画意,hyperverbosity的注释。简而言之,保持注释简单直接。
  7. 使用一致的注释风格
  一些人坚信注释应该写到能被非编程者理解的程度。而其他的人则认为注释只要能被开发人员理解就行了。无论如何,Successful Strategies for Commenting Code已经规定和阐述了注释的一致性和针对的读者。就个人而言,我怀疑大部分非编程人员将会去阅读代码,因此注释应该是针对其他的开发者而言。
  8. 使用特有的标签
  在一个团队工作中工作时,为了便于与其它程序员沟通,应该采用一致的标签集进行注释。例如,在很多团队中用TODO标签表示该代码段还需要额外的工作。
  int Estimate(int x, int y)
  {
  // TODO: implement the calculations
  return 0;
  }
  注释标签切忌不要用于解释代码,它只是引起注意或传递信息。如果你使用这个技巧,记得追踪并确认这些信息所表示的是什么。
  9. 在代码时添加注释
  在写代码时就添加注释,这时在你脑海里的是清晰完整的思路。如果在代码最后再添加同样注释,它将多花费你一倍的时间。而“我没有时间写注释”,“我很忙”和“项目已经延期了”这都是不愿写注释而找的借口。一些开发者觉得应该write comments before code,用于理清头绪。例如:
  public void ProcessOrder()
  {
  // Make sure the products are available
  // Check that the customer is valid
  // Send the order to the store
  // Generate bill
  }
  10. 为自己注释代码
  当注释代码时,要考虑到不仅将来维护你代码的开发人员要看,而且你自己也可能要看。用Phil Haack大师的话来说就是:“一旦一行代码显示屏幕上,你也就成了这段代码的维护者”。因此,对于我们写得好(差)的注释而言,我们将是第一个受益者(受害者)。(tjwzjs)
本文地址:https://www.eechina.com/thread-101845-1-1.html     【打印本页】

本站部分文章为转载或网友发布,目的在于传递和分享信息,并不代表本网赞同其观点和对其真实性负责;文章版权归原作者及原出处所有,如涉及作品内容、版权和其它问题,我们将根据著作权人的要求,第一时间更正或删除。
hyfly 发表于 2012-11-22 19:35:28
学习了,谢谢!
jackxcj 发表于 2012-11-23 16:50:10
看过
您需要登录后才可以发表评论 登录 | 立即注册

厂商推荐

相关视频

关于我们  -  服务条款  -  使用指南  -  站点地图  -  友情链接  -  联系我们
电子工程网 © 版权所有   京ICP备16069177号 | 京公网安备11010502021702
快速回复 返回顶部 返回列表