本文由&- 小峰原创翻译，转载请看清文末的转载要求，欢迎参与我们的！
你有没有这样的经历：别人审查过你的代码之后给出的注释，你认为是没有必要的？注释代码是为了提高代码的可读性，目的是为了能让其他人更容易理解你的代码。
我特别讨厌这5种注释类型以及制造它们的。希望你不是其中之一。
1.自以为很了不得的程序员
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
这个程序员自认为写了一段很了不得的代码，所以觉得有必要用自己的名字对每行代码进行标记。实施版本控制系统（VCS）能实现对代码变更的问责，但是也不会这么明显知道谁应对此负责。
2.过时的程序员
public class Program
static void Main(string[] args)
/* This block of code is no longer needed
* because we found out that Y2K was a hoax
* and our systems did not roll over to 1/1/1900 */
//DateTime today = DateTime.T
//if (today == new DateTime())
today = today.AddYears(100);
string message = "The date has been fixed for Y2K.";
Console.WriteLine(message);
如果一段代码已不再使用（即过时），那就删除它----不要浪费时间给这些代码写注释。此外，如果你需要复制这段被删除的代码，别忘了还有版本控制系统，你完全可以从早期的版本中恢复代码。
3.多此一举的程序员
public class Program
static void Main(string[] args)
/* This is a for loop that prints the
* words "I Rule!" to the console screen
* 1 million times, each on its own line. It
* accomplishes this by starting at 0 and
* incrementing by 1. If the value of the
* counter equals 1 million the for loop
* stops executing.*/
for (int i = 0; i & 1000000; i++)
Console.WriteLine("I Rule!");
我们都知道基础的编程逻辑是如何工作的----所以你不需要多此一举来解释这些显而易见的工作原理，虽然说你解释得很happy，但这只是在浪费时间和空间。
4.爱讲故事的程序员
public class Program
static void Main(string[] args)
/* I discussed with Jim from Sales over coffee
* at the Starbucks on main street one day and he
* told me that Sales Reps receive commission
* based upon the following structure.
* Friday: 25%
* Wednesday: 15%
* All Other Days: 5%
* Did I mention that I ordered the Caramel Latte with
* a double shot of Espresso?
double price = 5.00;
double commissionR
if (DateTime.Today.DayOfWeek == DayOfWeek.Friday)
commissionRate = .25;
else if (DateTime.Today.DayOfWeek == DayOfWeek.Wednesday)
commissionRate = .15;
commissionRate = .05;
commission = price * commissionR
如果你一定要在注释里提及需求，那么不要涉及别人的名字。销售部门的Jim可能会离开公司，而且很有可能大多数程序员根本不知道这是何许人也。不要在注释里提及不相干的事实。
5.“以后再做”的程序员
public class Program
static void Main(string[] args)
//TODO: I need to fix this someday - 07/24/1995 Bob
/* I know this error message is hard coded and
* I am relying on a Contains function, but
* someday I will make this code print a
* meaningful error message and exit gracefully.
* I just don't have the time right now.
string message = "An error has occurred";
if(message.Contains("error"))
throw new Exception(message);
这种类型的注释包含了上面所有其他类型。如果是在项目的初始开发阶段，这种待做注释是非常有用的，但如果是在几年后的产品代码----那就会出问题了。如果有什么需要修复的，立马解决，不要把它搁置一边，“以后再做”。
如果你也常常犯这样的注释错误，如果你想了解注释的最佳做法，我建议你阅读类似于Steve McConnell写的《Code Complete》这样的好书。
另外笔者也推荐你阅读以下内容：《》、《》
译文链接：
英文原文：
翻译作者：&- 小峰
[&转载必须在正文中标注并保留原文链接、译文链接和译者等信息。]
在文章中找不到问题***？您还可以
热门栏目订阅新手园地& & & 硬件问题Linux系统管理Linux网络问题Linux环境编程Linux桌面系统国产LinuxBSD& & & BSD文档中心AIX& & & 新手入门& & & AIX文档中心& & & 资源下载& & & Power高级应用& & & IBM存储AS400Solaris& & & Solaris文档中心HP-UX& & & HP文档中心SCO UNIX& & & SCO文档中心互操作专区IRIXTru64 UNIXMac OS X门户网站运维集群和高可用服务器应用监控和防护虚拟化技术架构设计行业应用和管理服务器及硬件技术& & & 服务器资源下载云计算& & & 云计算文档中心& & & 云计算业界& & & 云计算资源下载存储备份& & & 存储文档中心& & & 存储业界& & & 存储资源下载& & & Symantec技术交流区安全技术网络技术& & & 网络技术文档中心C/C++& & & GUI编程& & & Functional编程内核源码& & & 内核问题移动开发& & & 移动开发技术资料ShellPerlJava& & & Java文档中心PHP& & & php文档中心Python& & & Python文档中心RubyCPU与编译器嵌入式开发驱动开发Web开发VoIP开发技术MySQL& & & MySQL文档中心SybaseOraclePostgreSQLDB2Informix数据仓库与数据挖掘NoSQL技术IT业界新闻与评论IT职业生涯& & & 猎头招聘IT图书与评论& & & CU技术图书大系& & & Linux书友会二手交易下载共享Linux文档专区IT培训与认证& & & 培训交流& & & 认证培训清茶斋投资理财运动地带快乐数码摄影& & & 摄影器材& & & 摄影比赛专区IT爱车族旅游天下站务交流版主会议室博客SNS站务交流区CU活动专区& & & Power活动专区& & & 拍卖交流区频道交流区
丰衣足食, 积分 688, 距离下一级还需 312 积分
论坛徽章:12
领导不知道脑袋里想些什么，要求补注释
目前代码有文件说明注释，每个函数的入参、功能、返回值的说明，以及少量的实现思路说明。
领导的要求是要对所有临时变量都有注释说明，要达到看到变量名及注释就能让门外汉明白该临时变量在函数中的作用，还拿美国代码标准来唬人。
觉得领导这想法有点蛋疼，感觉这么写出来的注释量能占到50%的篇幅
& |& & |& & |& & |&
小富即安, 积分 2658, 距离下一级还需 2342 积分
论坛徽章:10
之前公司有同事专门写注释的，，，你没看错，除了写注释，他不干别的。
丰衣足食, 积分 688, 距离下一级还需 312 积分
论坛徽章:12
& & 我知道有这样的，不过我这从需求到设计再到开发，甚至包括一小半的测试，注释还得写成这样。&&觉得领导是不是想要fire掉我们组
小富即安, 积分 2658, 距离下一级还需 2342 积分
论坛徽章:10
& & 注释清楚就行了，还真不知道领导怎么想。
丰衣足食, 积分 705, 距离下一级还需 295 积分
论坛徽章:1
wsysx 发表于
领导不知道脑袋里想些什么，要求补注释
目前代码有文件说明注释，每个函数的入参、功能、返回值的说明，以 ...
这还不理解么，要是你文档注释都写好了，随便什么人都能替代你；要是一团乱麻，谁敢赶你走啊；拖着呗，实在不行表示不干了，看他能够拿你怎么样
富足长乐, 积分 6436, 距离下一级还需 1564 积分
论坛徽章:33
这个解释好
小富即安, 积分 3624, 距离下一级还需 1376 积分
论坛徽章:77
赞一个，理解的非常深刻。回复
lost_templar
家境小康, 积分 1490, 距离下一级还需 510 积分
论坛徽章:3
见过70%注释的代码，买的。
丰衣足食, 积分 688, 距离下一级还需 312 积分
论坛徽章:12
去年过年前是一顿要求补文档，组内补了上千页的文档，今年改成补注释了。
不过换个角度看，活轻松，还不耽误拿工资
丰衣足食, 积分 705, 距离下一级还需 295 积分
论坛徽章:1
想想看，一个刚出校门工作了没有几年的家伙要来你们公司，只要你三分之一的工资，如果你的代码注释很详细，他完全可以接手你的工作；换你是老板，你会做出什么选择？
所以注释自己的代码，其实就是稀里糊涂的***……
北京皓辰网域网络信息技术有限公司. 版权所有 京ICP证:060528号 北京市公安局海淀分局网监中心备案编号：
广播电视节目制作经营许可证(京) 字第1234号
中国互联网协会会员&&联系我们：
感谢所有关心和支持过ChinaUnix的朋友们
转载本站内容请注明原作者名及出处酒店点菜系统的开发与实现说明书_百度文库
两大类热门资源免费畅读
续费一年阅读会员，立省24元！
酒店点菜系统的开发与实现说明书
上传于||暂无简介
阅读已结束，如果下载本文需要使用1下载券
想免费下载本文？
定制HR最喜欢的简历
下载文档到电脑，查找使用更方便
还剩14页未读，继续阅读
定制HR最喜欢的简历
你可能喜欢
