千万要避免的五种程序注释方式小结

你是否曾在复查程序时发现某些注释似乎毫无价值或过于冗余？程序注释的存在，是为了提高代码的可读性，帮助开发者更好地理解程序的逻辑和功能。有时候我们会发现一些注释不仅没有达到这个目的，反而让人困扰。在此，我将这些看似无用的注释及其背后的程序员分为五种类型，希望你在阅读这篇文章后，能确信自己不属于其中的任何一种。

一、自恋的程序员

这些程序员的代码示例如下：

```csharp

public class Program

{

static void Main(string[] args)

{

string message = “Hello World!”; // 07/24/2010 Bob

Console.WriteLine(message); // 07/24/2010 Bob

message = “I am so proud of this code!”; // 07/24/2010 Bob

Console.WriteLine(message); // 07/24/2010 Bob

}

}

```

这些程序员在每行代码后都附上了自己的大名和日期，仿佛是在炫耀自己的存在。这种做法并不明智。版本控制系统已经能够记录代码的每一次变更，这样的注释只会让代码显得杂乱无章。

二、遗老的程序员

他们的代码示例可能如下：

```csharp

public class Program

{

static void Main(string[] args)

{

// 这段程序已经不再有用，因为我们发现千年虫问题只是一场虚惊

// 我们的系统不会恢复到1/1/1900

//DateTime today = DateTime.Today;

//if (today == new DateTime(1900, 1, 1))

//{

// today = today.AddYears(100);

// string message = “The date has been fixed for Y2K.”;

// Console.WriteLine(message);

//}

}

}

```

这类程序员可能会保留过时的代码注释，这些注释可能已经不再适用于当前的程序。这种做法会导致代码混乱，给后来的开发者带来困扰。优秀的程序员应该保持代码的简洁和清晰。同时他们会积极地更新和维护代码以适应新的需求和变化。如果你发现自己经常保留过时的代码注释，那么是时候重新审视你的编程习惯并做出改变了。记住，好的代码应该像艺术品一样简洁而富有美感。不要让无用的注释成为你代码中的“赘肉”。