简评:要说到代码注释这个东西吧,其实很神奇,因为不管写不写注释,其实对于代码的运行没有任何的影响,注释的长短也没关系,因为编译器会对于所有的代码注释都是过滤掉的,其实注释非常重要,对后期的代码维护和重构至关重要,但是其实很多程序员童鞋在写代码时往往并不注意注释,所以导致自己回头看自己的代码时也都忘了写的是什么,本文给出了 StackOverflow 网友针对“你看到过的最好的代码注释是什么样的?”这个问题给出的回答的前10条。
1、
// 亲爱的维护者:
// 如果你尝试了对这段程序进行‘优化’,
// 并认识到这种企图是大错特错,请增加
// 下面这个计数器的个数,用来对后来人进行警告:
// 浪费在这里的总时间 = 39h
2、
/** * 致终于来到这里的勇敢的人:
你是被上帝选中的人,英勇的、不辞劳苦的、不眠不修的来修改
我们这最棘手的代码的编程骑士。你,我们的救世主,人中之龙,
我要对你说:永远不要放弃,永远不要对自己失望,永远不要逃走,辜负了自己。
永远不要哭啼,永远不要说再见。永远不要说谎来伤害自己。 */
Exception up = new Exception("Something is really wrong."); throw up;
4、
// 一些修改1 - 2002/6/7 增加临时的跟踪登录界面
// 一些修改2 - 2007/5/22 我临时的犯傻
5、
#define TRUE FALSE //逗一逗调试程序的傻瓜们
6、
if (/*you*/ $_GET['action']) { //celebrate(恭喜)
7、
//如果这段代码好用,那它是Paul DiLascia写的。
//如果不好用,我不知道是谁写的。
8、
//写这段代码的时候,只有上帝和我知道它是干嘛的
//现在,只有上帝知道
9、
// 晕了,以后再修改
10、
// 神奇。勿动。
你有没有遇到过更绝的?
本文转载自 stackoverflow 译者:外刊IT评论 链接:www.vaikan.com/10-best-code-comments/原文有修改