代码界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/原文有修改
相关文章
|
25天前
|
存储 缓存 Java
写代码原来如此简单:两种常用代码范式
一次项目包含非常多的流程,有需求拆解,业务建模,项目管理,风险识别,代码模块设计等等,如果我们在每次项目中,都将精力大量放在这些过程的思考上面,那我们剩余的,放在业务上思考的精力和时间就会大大减少;这也是为什么我们要 总结经验/方法论/范式 的原因;这篇文章旨在建立代码模块设计上的思路,给出了两种非常常用的设计范式,减少未来在这一块的精力开销。
|
5月前
|
算法 Java 开发者
探索代码世界:我的编程之旅
在数字时代的浪潮中,编程已成为一门艺术和科学的结合体。本文将带领读者穿梭于代码的迷宫,分享个人的技术感悟,从初识编程的迷茫到深入其境的喜悦,探讨如何通过编程解决实际问题,以及编程带来的思维转变和生活影响。文章旨在为编程初学者提供一盏指路灯,同时也为资深开发者带来共鸣。
|
5月前
|
算法 数据处理 数据库
探索代码世界的魔法:我的编程之旅
【8月更文挑战第31天】 在编程的世界里,每一行代码都像是施法的咒语,拥有改变数字世界的力量。本文将带你走进一个初学者眼中的编程世界,一起感受从零开始构建项目的兴奋与挑战。通过分享个人的学习经历和心得,我们将探讨编程基础、项目实践以及持续学习的重要性,同时提供实用的代码示例,旨在激励和指导编程新手开启自己的技术探索之旅。
|
5月前
|
人工智能 算法 安全
代码之诗:我的编程之旅
在数字世界的无限画布上,每一行代码都是一笔精细的勾勒,每一个算法都是深邃的思考。本文是一次个人技术感悟的分享,从初识编程的困惑与好奇到深入掌握后的创造与热情,再到对技术趋势的洞察与适应,我试图将编程比作一首诗,通过个人经历展现编程艺术的魅力和挑战,并探讨如何持续学习以适应不断变化的技术环境。
|
5月前
|
算法 程序员
代码间的诗篇:我的编程之旅
【8月更文挑战第5天】 在数字世界中,编程不仅仅是一项技术活动,它更像是一种艺术。本文将通过个人经历探索编程的美学,从初识编程的困惑到逐渐掌握后的成就感,再到深刻理解代码背后的逻辑美。我们将一起走进编程的世界,感受它在解决问题、创造新事物中的魅力,以及它如何影响我们的生活和思维方式。
43 0
|
7月前
|
JSON 自然语言处理 前端开发
学会这个插件,职业生涯少写 1w 行代码。
学会这个插件,职业生涯少写 1w 行代码。
52 0
|
8月前
|
算法 程序员
编程遗产:祖传代码
编程遗产:祖传代码
|
8月前
|
设计模式 算法 程序员
如何写出好的代码注释?
作为程序员,想必大家在日常开发中必写注释,而且在软件开发过程中,给代码写注释是一项至关重要的工作,也是一名合格的程序员该具备的编程素养。恰当的注释可以提高代码的可读性和可维护性,方便其他人理解熟悉和修改代码,但是不恰当或过度的注释可能会导致混乱和误导,会起到适得其反的作用。那么本文就来分享一些关于如何正确地给代码写注释的方法和指导原则,并提供一些减少注释但仍能让他人理解代码的方法。
193 3
如何写出好的代码注释?
|
8月前
|
设计模式 算法 Java
|
8月前
|
人工智能 程序员 API
代码注释对于程序员重要吗?
代码注释对于程序员重要吗?
71 0

热门文章

最新文章