你看到过的最好的代码注释是什么样的?

开发 前端
编写代码良好的习惯就是写清楚注释,方便自己查阅也方便后来者熟悉代码,然而很多人留下的代码注释却让你啼笑皆非

下面是stackoverflow网站上网友针对你看到过的***的代码注释是什么样的?这个问题给出的回答的前10条:

  1. // 亲爱的维护者:  
  2. // 如果你尝试了对这段程序进行‘优化’,  
  3. // 并认识到这种企图是大错特错,请增加  
  4. // 下面这个计数器的个数,用来对后来人进行警告:  
  5. // 浪费在这里的总时间 = 39h 
  1. /** * 致终于来到这里的勇敢的人:  
  2.     你是被上帝选中的人,英勇的、不辞劳苦的、不眠不修的来修改  
  3. 我们这最棘手的代码的编程骑士。你,我们的救世主,人中之龙,  
  4. 我要对你说:永远不要放弃,永远不要对自己失望,永远不要逃走,辜负了自己。  
  5. 永远不要哭啼,永远不要说再见。永远不要说谎来伤害自己。 */ 
  1. Exception up = new Exception("Something is really wrong."); throw up;  
  1. // 一些修改1 - 2002/6/7 增加临时的跟踪登录界面  
  2. // 一些修改2 - 2007/5/22 我临时的犯傻 
  1. #define TRUE FALSE //逗一逗调试程序的傻瓜们 
  1. if (/*you*/ $_GET['action']) { //celebrate(恭喜) 
  1. // 如果这段代码好用,那它是Paul DiLascia写的。  
  2. //如果不好用,我不知道是谁写的。 
  1. //写这段代码的时候,只有上帝和我知道它是干嘛的  
  2. //现在,只有上帝知道 
  1. // 晕了,以后再修改 
  1. // 神奇。勿动。 

你有没有更绝的?

原文:http://www.aqee.net/10-best-code-comments/

【编辑推荐】

  1. 利用Visual Studio 2008宏实现自动注释
  2. 注释里的诅咒:哪种语言遭受最多的咒骂?
  3. 程序员,你可不能安排休假
  4. 烂程序员要么编程要么被编程
  5. 程序员们 不要想一辈子靠技术混饭吃
责任编辑:陈贻新 来源: 外刊IT评论
相关推荐

2014-09-12 10:38:01

程序员代码

2012-04-05 10:34:01

Windows 8开始屏幕

2017-07-27 16:25:54

云管理公共云合并

2017-12-17 16:53:27

云计算亚马逊云端

2022-10-30 15:03:25

人工智能仓库管理机器人

2013-01-31 11:51:37

开源KVM

2013-02-27 10:53:16

开源KVM

2018-06-06 16:25:44

2015-04-08 10:40:09

2015-12-31 09:36:55

程序员最理想公司

2022-06-13 23:30:27

代码词汇高质量

2013-08-20 10:31:16

云计算2.0云计算

2020-12-03 06:34:34

分支策略SIT

2012-11-09 10:11:42

搜索引擎

2023-12-04 06:55:16

2022-09-09 07:35:23

循环依赖Spring构造器

2015-04-15 15:01:56

代码好代码科学定义

2023-01-09 11:54:13

物联网IOT

2010-11-01 14:45:35

云计算
点赞
收藏

51CTO技术栈公众号