一、自恋型注释
(注:原文为Proud,我觉得“自恋”更好一点)
- public class Program
- {
- static void Main(string[] args)
- {
- string message = "Hello World!";
- Console.WriteLine(message);
- message = "I am so proud of this code!";
- Console.WriteLine(message);
- }
- }
原文:这样的程序员对于自己的代码改动非常骄傲和自恋,所以,他觉得需在在这些自己的代码上标上自己的名字。其实,一个版本控制工具(如:CVS或Subversion)可以完整地记录下所有的关于代码的改动的和作者相关的一切信息,只不过不是那么明显罢了。
二、废弃代码的注释
- public class Program
- {
- static void Main(string[] args)
- {
-
-
-
-
-
-
-
-
-
-
- }
- }
原文:如果某段代码不再使用了,那就应该直接删除。我们不应该使用注释来标准废弃的代码。同样,我们有版本控制工具来管理我们的源代码,在版本控制工具里,是不可能有代码能被真正的物理删除的。所以,你总是可以从以前的版本上找回你的代码的。
三、明显的注释
- public class Program
- {
- static void Main(string[] args)
- {
-
-
-
-
-
-
-
-
- for (int i = 0; i < 1000000; i++)
- {
- Console.WriteLine("I Rule!");
- }
- }
- }
原文:看看上面的例子,代码比注释还容易读。是的,大家都是程序员,对于一些简单的,显而易见的程序逻辑,不需要注释的。而且,你不需要在你的注释中教别人怎么编程,你这是在浪费时间去解释那些显而易见的东西。你应该用注释去解释你的代码功能,原因,想法,而不是代码本身。
四、故事型注释
- public class Program
- {
- static void Main(string[] args)
- {
-
-
-
-
-
-
-
-
-
-
-
- double price = 5.00;
- double commissionRate;
- double commission;
- if (DateTime.Today.DayOfWeek == DayOfWeek.Friday)
- {
- commissionRate = .25;
- }
- else if (DateTime.Today.DayOfWeek == DayOfWeek.Wednesday)
- {
- commissionRate = .15;
- }
- else
- {
- commissionRate = .05;
- }
- commission = price * commissionRate;
- }
-
- }
原文:如果你不得不在你的代码注释中提及需求,那也不应该提及人名。在上面的示例中,好像程序想要告诉其它程序员,下面那些代码的典故来自销售部的Jim,如果有不懂的,你可以去问他。其实,这根本没有必要在注释中提到一些和代码不相干的事。
五、“TODO”注释
- public class Program
- {
- static void Main(string[] args)
- {
-
-
-
-
-
-
-
-
- string message = "An error has occurred";
- if(message.Contains("error"))
- {
- throw new Exception(message);
-
- }
-
- }
- }
原文:当你在初始化一个项目的时候,TODO注释是非常有用的。但是,如果这样的注释在你的产品源码中出现了N多年,那就有问题了。如果有BUG要被fix,那就Fix吧,没有必要整一个TODO。
原文地址http://www.csdn.net/article/2010-07-28/277372