代码界10个最“牛叉”的代码注释

简介: 要说到代码注释这个东西吧,其实很神奇,因为不管写不写注释,其实对于代码的运行没有任何的影响,注释的长短也没关系,因为编译器会对于所有的代码注释都是过滤掉的,其实注释非常重要,对后期的代码维护和重构至关重要,但是其实很多程序员童鞋在写代码时往往并不注意注释,所以导致自己回头看自己的代码时也都忘了写的是什么,本文给出了 StackOverflow 网友针对“你看到过的最好的代码注释是什么样的?”这个问题给出的回答的前10条。

简评:要说到代码注释这个东西吧,其实很神奇,因为不管写不写注释,其实对于代码的运行没有任何的影响,注释的长短也没关系,因为编译器会对于所有的代码注释都是过滤掉的,其实注释非常重要,对后期的代码维护和重构至关重要,但是其实很多程序员童鞋在写代码时往往并不注意注释,所以导致自己回头看自己的代码时也都忘了写的是什么,本文给出了 StackOverflow 网友针对“你看到过的最好的代码注释是什么样的?”这个问题给出的回答的前10条。


1、
    // 亲爱的维护者:
    // 如果你尝试了对这段程序进行‘优化’,
    // 并认识到这种企图是大错特错,请增加
    // 下面这个计数器的个数,用来对后来人进行警告:
    // 浪费在这里的总时间 = 39h

2、

    /** * 致终于来到这里的勇敢的人:
     你是被上帝选中的人,英勇的、不辞劳苦的、不眠不修的来修改
     我们这最棘手的代码的编程骑士。你,我们的救世主,人中之龙,
     我要对你说:永远不要放弃,永远不要对自己失望,永远不要逃走,辜负了自己。

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


8cb1739676970fad0d2bc3ddc7a044823d846c1f

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  译者:外刊IT评论 链接:www.vaikan.com/10-best-code-comments/原文有修改
相关文章
|
6月前
|
自然语言处理 算法 Java
C/C++ 程序员编程规范之注释
C/C++ 程序员编程规范之注释
181 1
|
5月前
|
JSON 自然语言处理 前端开发
学会这个插件,职业生涯少写 1w 行代码。
学会这个插件,职业生涯少写 1w 行代码。
42 0
|
6月前
|
算法 程序员
编程遗产:祖传代码
编程遗产:祖传代码
|
6月前
|
设计模式 算法 程序员
如何写出好的代码注释?
作为程序员,想必大家在日常开发中必写注释,而且在软件开发过程中,给代码写注释是一项至关重要的工作,也是一名合格的程序员该具备的编程素养。恰当的注释可以提高代码的可读性和可维护性,方便其他人理解熟悉和修改代码,但是不恰当或过度的注释可能会导致混乱和误导,会起到适得其反的作用。那么本文就来分享一些关于如何正确地给代码写注释的方法和指导原则,并提供一些减少注释但仍能让他人理解代码的方法。
145 3
如何写出好的代码注释?
|
6月前
|
设计模式 算法 Java
|
6月前
|
人工智能 程序员 API
代码注释对于程序员重要吗?
代码注释对于程序员重要吗?
55 0
|
6月前
|
Java
注释之背后:代码的解释者与保护者
注释之背后:代码的解释者与保护者
39 0
|
机器学习/深度学习 自然语言处理 算法
程序员的炫技代码写法
程序员的炫技代码写法
|
程序员
笑出腹肌!有些程序员真会玩代码注释
笑出腹肌!有些程序员真会玩代码注释
91 0
笑出腹肌!有些程序员真会玩代码注释
|
Python Windows
你真的看得懂报错吗?
你真的看得懂报错吗?
317 0
你真的看得懂报错吗?