侵权投诉
订阅
纠错
加入自媒体

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

2012-11-21 16:16
月城清浅
关注

  很多程序员在写代码的时候往往都不注意代码的可读性,让别人在阅读代码时花费更多的时间。其实,只要程序员在写代码的时候,注意为代码加注释,并以合理的格式为代码加注释,这样就方便别人查看代码,也方便自己以后查看了。下面分享十个加注释的技巧:

  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();

  . . .

1  2  3  下一页>  
声明: 本文由入驻维科号的作者撰写,观点仅代表作者本人,不代表OFweek立场。如有侵权或其他问题,请联系举报。

发表评论

0条评论,0人参与

请输入评论内容...

请输入评论/评论长度6~500个字

您提交的评论过于频繁,请输入验证码继续

暂无评论

暂无评论

文章纠错
x
*文字标题:
*纠错内容:
联系邮箱:
*验 证 码:

粤公网安备 44030502002758号