美文网首页
最好的代码注释是什么样的?

最好的代码注释是什么样的?

作者: ksceasar | 来源:发表于2016-12-08 08:46 被阅读0次

下面是 StackOverflow 网友针对“你看到过的最好的代码注释是什么样的?”这个问题给出的回答的前10条:

1、

// 亲爱的维护者:

// 如果你尝试了对这段程序进行‘优化’,

// 并认识到这种企图是大错特错,请增加

// 下面这个计数器的个数,用来对后来人进行警告:

// 浪费在这里的总时间 = 39h

2、

/** * 致终于来到这里的勇敢的人:

你是被上帝选中的人,英勇的、不辞劳苦的、不眠不修的来修改

我们这最棘手的代码的编程骑士。你,我们的救世主,人中之龙,

我要对你说:永远不要放弃,永远不要对自己失望,永远不要逃走,辜负了自己。

永远不要哭啼,永远不要说再见。永远不要说谎来伤害自己。 */

3、

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 网友针对“你看到过的最好的代码注释是什么样的?”这个问题给出的回答的前10条:...

  • 分享一些工作中的习惯~

    对于复杂的代码逻辑,添加清楚的注释 写代码的时候,是没有必要写太多的注释的,好的方法变量命名就是最好的注释。 但是...

  • 华山论剑之浅谈XMPP协议实现即时通讯功能

    优秀的代码是它自己最好的文档。当你考虑要添加一个注释时,问问自己,“如何能改进这段代码,以让它不需要注释?”* X...

  • Python之注释

    以#开头的行就是注释 单行注释:#注释 #只能注释掉#后的部分 代码前的注释是为了解释下面的代码;代码后的注释是为...

  • 注释是代码的补充

    为什么要写注释? 代码无法体现开发者在编写代码时脑中所想的关于当前模块的全部重要信息。代码太精确了(代码主要是给计...

  • 程序员被怼后,在代码注释里,告诉这家公司有多坑

    每个程序员敲代码都有自己的特色风格,好的代码本身就是最好的说明文档。而注释就是起到这个作用,注释就是对代码的解释和...

  • Python 简明教程 --- 8,Python 字符串函数

    好代码本身就是最好的文档。当你需要添加一个注释时,你应该考虑如何修改代码才能不需要注释。—— Steve McCo...

  • 代码的注释

    什么是注释就是对代码的注解.解释代码是做什么事情的.方便我们以后查看代码.提高的阅读性. 单行注释// 后面的这1...

  • 2018-02-01

    1-6.#了解HTML的代码注释 *什么是代码注释? 代码注释的作用是帮助程序员标注代码的用途,过一段...

  • 必须知道的C语言知识细节:注释三种使用方式区别

    注释的作用是给代码做说明,方便别人阅读和理解代码,写注释是很好的编程习惯。编译器会直接忽略代码中的注释,注释不对程...

网友评论

      本文标题:最好的代码注释是什么样的?

      本文链接:https://www.haomeiwen.com/subject/khgjmttx.html