编程风格——五种应该避免的代码注释

五种应该避免的代码注释

在酷壳，有很多文章都提到了代码注释，如：《十条不错的编程观点》、《优质代码的十诫》、《整洁代码的4个提示》、《惹恼程序员的十件事》等等。今天，某国外的程序员在这里列举五种应该避免的程序注释，我觉得比较有道理，但我觉得有少数几个观点也并不绝对。所以，我把原文的这五种应该避免的程序注释罗列在下面，并放上原作者和我的个人观点作为比较。希望对大家有用。

一、自恋型注释
（注：原文为Proud，我觉得“自恋”更好一点）

 1 publicclassProgram
 2 {
 3 staticvoidMain(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 }
10 }

View Code