15972200308 | admin@cktoo.com
当前位置:  网站首页 > 网络知识

养成好习惯 关于代码注释的7个技巧

 1. 对不同级别的代码进行注释

对于不同级别的代码块,要使用统一的方法来进行注释。例如:

对于每一个类,需要包含一段简明扼要的描述,作者和上一次修改的时间

对于每一个方法,需要包含这个方法的用途,功能,参数以及返回结果

当你在一个团队里面的时候,采用一套注释的标准是非常重要的。当然,使用一种大家都认可的注释约定和工具(例如C#的XML注释和Java的Javadoc)在一定程度上能推动这项任务。

2. 使用段落注释

首先把代码块分解成多个“段落”,每一个段落都执行单一的任务;然后在每一个“段落”开始之前添加注释,告诉阅读代码的人接下来的这段代码是干什么用的

 

3. 对齐注释行

对于那些在行末写有注释的代码,应该对齐注释行来使得方便阅读

有些开发人员使用tab来对齐注释,而另外一些人会用空格来对齐。由于tab在不同的编辑器和集成开发环境中会有所不同,所以最佳的方法是使用空格来对齐注释行。

 

4. 不要侮辱阅读者的智慧

要避免没用的注释,例如

 

这不单把时间浪费在写没用的注释上面,同时也在分散读者的注意力。

5. 要有礼貌

应当避免没有礼貌的注释,例如“要注意一些愚蠢的用户会输入一个负数”,或者“修正由菜鸟工程师写的愚蠢得可怜的代码而导致的副作用”。这样的注释对于代码的写注释的人来说并没有任何好处,同时你永远都不会知道将来这些注释会被谁来阅读,你的老板,一个客户或者是刚才被你数落的愚蠢得可怜的工程师。

6. 直截了当

不要在注释里面写过多的废话。避免在注释里面卖弄ASCII艺术,写笑话,作诗和过于冗长。简而言之就是保持注释的简单和直接。

7. 使用统一的风格

有些人觉得注释应该让非程序员也能看懂。另外一些人觉得注释需要面对的读者只是程序员。无论如何,正如Successful Strategies for Commenting Code中所说的,最重要的是注释的风格需要统一,并且总是面向相同的读者。就自己而论,我怀疑非程序员是否会去读代码,所以我觉得注释应该面向程序员来写。


武汉朵朵云信息技术有限公司

座机:027-83856050 (总机)

手机:15972200308  (向经理)
售后:17786477463
Q  Q:86117879 
邮箱:admin@cktoo.com


点击次数:  更新时间:2017-05-09 09:32:56  【打印此页】  【关闭
About Us

天之汇是武汉朵朵云信息技术有限公司旗下的品牌,对外宣传光谷网络,我们提供专业网站建设、微信开发、APP开发服务 秉持著以最专业的态度替客户进行网站建置、网页设计、网页程式撰写以及网络营销等服务,

我们深信只有将这些环节都做到完美,才能替客户从网路上带来最大的效益,并降低制作成本。

为抱持著这样的服务信念,并在数年内,服务各行各业的為数众多的客户,因為我们拥有创意与美感兼备的设计团队,

多样化与专业的程序设计经验,所以能够提供各种关於网页设计的问题解决方案,让选择我们的客户都能得到最强而有力的支援。


Enterprise Chain
Get In Touch

武汉市武昌区武珞路中南国际城A1座2402

15972200308/027-83856050

Sales Email Account:
admin@cktoo.com
Copyright © 2008 - 2016 武汉朵朵云. All Rights Reserved.
网站建设服务领域的领导者
技术支持:武汉网站建设
友情链接:

朵朵云在线客服
竭诚为您服务!

  • 027-83856050
  • 15972200308