程序员,拒绝垃圾注释!

开发
你是否有过复查程序时发现有些注释毫无用处?程序注释是为了提高代码的可读性,然而,很多时候程序员写的注释语句毫无意义,文章将介绍五种应该避免的注视方式。

你是否有过复查程序时发现有些注释毫无用处?程序注释是为了提高代码的可读性,为了让原作者以外的其他开发人员更容易理解这段程序,但更多时候,程序们们写出的注释语句都毫无意义。

51CTO推荐阅读:程序员的十大技术烦恼

文章把这些让人郁闷的注释方式归为了五类,同时把写出这些注释的程序员也归为了五类。希望读了这篇文章后你感觉自己不属于其中的任何一种类型。

1. 高傲的程序员

  1. public class Program  
  2. {  
  3.     static void Main(string[] args)  
  4.     {  
  5.         string message = “Hello World!”;  // 07/24/2010 Bob  
  6.         Console.WriteLine(message); // 07/24/2010 Bob  
  7.         message = “I am so proud of this code!”; // 07/24/2010 Bob  
  8.         Console.WriteLine(message); // 07/24/2010 Bob  
  9.     }  

这种程序员是如此的欣赏自己的程序,以至于不得不在每行代码上都署上自己的大名。应该让版本控制系统来提供程序变更的信息,他这样做一眼看去并不能说明谁对这行代码负责。

2. 过时的程序员

  1. public class Program  
  2. {  
  3.     static void Main(string[] args)  
  4.     {  
  5.         /* 这段程序已经不再有用  
  6.          * 因为我们发现千年虫问题只是一场虚惊  
  7.          * 我们的系统不会恢复到1/1/1900 */  
  8.         //DateTime today = DateTime.Today;  
  9.         //if (today == new DateTime(1900, 1, 1))  
  10.         //{  
  11.         //    todaytoday = today.AddYears(100);  
  12.         //    string message = “The date has been fixed for Y2K.”;  
  13.         //    Console.WriteLine(message);  
  14.         //}  
  15.     }  

如果一段程序不再有用(比如废弃了),那就删了它吧——不要被几行没用的注释搞的程序混乱不堪。即使你可能以后重用这段代码,你也可以使用版本控制系统,用它把你的程序恢复到以前的样子。

3. 天真的程序员

  1. public class Program  
  2. {  
  3.     static void Main(string[] args)  
  4.     {  
  5.         /* 这个程序是用来在屏幕上  
  6.          * 循环打印1百万次”I Rule!”  
  7.          * 每次输出一行。循环计数  
  8.          * 从0开始,每次加1。  
  9.          * 当计数器等于1百万时,  
  10.          * 循环就会停止运行*/  
  11.  
  12.         for (int i = 0; i < 1000000; i++)  
  13.         {  
  14.             Console.WriteLine(“I Rule!”);  
  15.         }  
  16.     }  

基本的编程语法规则我们大家都知道——我们不需要“编程入门”。你不需要浪费时间来解释一个显而易见的东西,我们更希望知道的是你的程序功能——那是浪费空间了。

4. 传奇的程序员

  1. public class Program  
  2. {  
  3.     static void Main(string[] args)  
  4.     {  
  5.        /* 有一天我在大街上的一家星巴克里  
  6.         * 和销售部的Jim讨论问题,他告诉我  
  7.         * 销售代表是依据以下的比例提取佣金的。  
  8.         * 周五: 25%  
  9.         * 周三: 15%  
  10.         * 其它日期: 5%  
  11.         * 我是否告诉你过我点了一个卡拉梅  
  12.         * 铁咖啡和两份的Espresso?   
  13.        */  
  14.         double price = 5.00;  
  15.         double commissionRate;  
  16.         double commission;  
  17.         if (DateTime.Today.DayOfWeek == DayOfWeek.Friday)  
  18.         {  
  19.             commissionRate = .25;  
  20.         }  
  21.         else if (DateTime.Today.DayOfWeek == DayOfWeek.Wednesday)  
  22.         {  
  23.             commissionRate = .15;  
  24.         }  
  25.         else  
  26.         {  
  27.             commissionRate = .05;  
  28.         }  
  29.         commission = price * commissionRate;  
  30.     }  

如果你不得不在注释里写明需求,那也不要提到人名。销售员Jim很可能在公司里不再是销售。而且大多数读到这段注释的程序员未必都知道Jim是谁。你描述的是实际情况但跟我们的内容不相干,所以就省掉吧。

5. 未来程序员

  1. public class Program  
  2. {  
  3.     static void Main(string[] args)  
  4.     {  
  5.        //TODO: 将来我会修复这个问题 – 07/24/1995 Bob  
  6.        /* 我知道这个问题很难解决而且  
  7.         * 我现在依赖于这个Contains函数,但  
  8.         * 我以后会用一种更有意义,更  
  9.         * 优雅的方式打印这段代码。  
  10.         * 我只是现在没时间。  
  11.        */  
  12.        string message = “An error has occurred”;  
  13.        if(message.Contains(“error”))  
  14.        {  
  15.            throw new Exception(message);  
  16.        }  
  17.     }  

这种注释是一种集大成者,它包含了上面所说的注释的所有问题。TODO注释在一个项目最初的开发阶段是非常有用的,但这个注释看起来是在好几年前的产品程序里的——它证明了程序有问题。如果程序有问题需要解决,马上解决,不要拖到日后再解决。

你是否在你的程序里还见到过其它种没有意义的或讨厌的注释?

【编辑推荐】

  1. 程序员的十大技术烦恼
  2. 浅析程序员编程水平提升的四个阶段
  3. 充满荆棘的专家程序员之道
  4. 最有争议的十大编程观点
  5. .NET程序员不得不遵守的二十条编码习惯
责任编辑:王晓东 来源: 外刊IT评论
相关推荐

2009-12-28 09:42:14

程序员

2018-03-30 10:28:23

2013-06-18 17:12:03

程序员开发工具付费

2023-01-12 12:53:00

程序员离职违法

2015-08-20 09:06:48

程序员

2021-02-03 09:41:27

春节电脑程序员

2013-08-20 09:33:59

程序员

2012-03-06 09:22:46

程序员

2020-08-20 08:27:31

程序员技术互联网

2013-07-05 10:16:32

程序员

2011-05-13 14:34:02

程序员

2009-05-21 15:58:12

程序员工作经验职场

2023-11-13 08:34:01

Java编程习惯

2020-12-21 14:46:56

代码开发程序员

2018-04-23 11:00:06

程序员养生健康

2020-07-17 09:55:11

程序员技能开发者

2012-11-22 14:00:26

程序员

2017-11-14 21:30:15

2010-09-01 11:06:16

程序员

2015-08-11 14:45:51

程序员
点赞
收藏

51CTO技术栈公众号