10个最“优秀”的代码注释

Java范思哲 2017-12-16 12:49:02 ⋅ 92 阅读

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


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

你有没有更绝的?



全部评论: 0

    我有话说:

    世界之开发项目:苦撑12年,600多万行代码

    “ 你见过项目,撑了多长时间才完蛋?六月?一年?今天介绍这个奇葩项目,不但一开始就烂得透透,还硬...

    「收藏版」JDK1.8工作中常用14Stream详细小示例

    一:简介 java.util.Stream 表示能应用在一组元素上一次执行操作序列。Stream 操作分为中间操作或者最终操作两种,最终操作返回一特定类型计算结果,而中间操作返回Stream本身

    精品推荐:【CKEditor】全球优秀网页在线文字编辑器之一

    CKEditor是新一代FCKeditor,是一个重新开发版本。CKEditor是全球优秀网页在线文字编辑器之一,因其惊人性能与可扩展性而广泛被运用于各大网站。

    GitHub精选:2018年11月份热门Java开源项目

    又到了揭晓 11 月份热门 Java 开源项目排名时候了,在本月名单中,出现了几新面孔,如Java 核心知识库、轻量级容错组件Resilience4j .....

    Java 14 有了这几新特性,开发直接飞起来!

    内容介绍: Record -- 简化了简单 Java 类创建。 Pattern Matching -- 简化了 instanceof 。 Switch 表达式 -- 简化了

    「开源资讯」陌陌安全团队开源Java静态代码审计插件

    陌陌安全本次开源Java静态代码安全审计插件,侧重于在编码过程中发现项目潜在安全风险,并提供一键修复能力。 此插件作为Java项目静态代码安全审计工具,侧重于在编码过程中发现项目潜在安全风险

    能够替代 Jenkins 13解决方案,了解下!

    Jenkins 是目前常用持续集成工具,拥有近 50% 市场份额,它还是很多技术团队第一使用自动化工具。但是随着自动化领域持续发展,Jenkins 逐渐暴露出了一些问题,例如缺乏功能

    Linux 5.10 第二批更新,ARM64 上功能优化

    10 月 22 日,Linux 5.10 发送了该内核第二批更新,此次对 ARM64 一些功能做了性能优化。当天拉取请求为 ARM64 上 Linux 5.10 启用了 HAVE_MOVE

    「强烈推荐」这是我看过接“地气”代码问题与重构实践

      写这个文章是因为前段时间确实因为公司业务开发太忙太紧,所有开发都处在于加班赶项目,并且加入新人较多造成了一系列代码不可控质量问题。 文章针对这段时间代码出现各种各样问题

    大公约数和小公倍数

    一. 基本概念: 如果数a能被数b整除,a就叫做b倍数,b就叫做a约数。约数和倍数都表示两整数关系,不能单独存在。 几整数中公有约束,叫做这几公约数;其中一个,叫做这几

    代码这样优化,瞬间清爽多了

    今天这篇文章我们又来聊聊代码优化。 隐藏行为细节 在平时开发过程中,你肯定会碰到这样业务,比如判断车速是否正常。一般编码如下: float speed = 60f

    「开源资讯」优麒麟 20.10 版本发布--简而美,华而实

    发布16 版本,提供 9 技术支持,...

    Docker 20.10.0 发布, K8s 宣布将弃用 Docker 容器进行时之后发布 版本

    Docker 20.10.0  发布了,这是自 K8s 宣布将弃用 Docker 容器进行时之后发布 Docker 版本。 本次更新内容包括: 弃用/移除 当 docker 从不

    CKEditor 5 v26.0.0 发布:具有可扩展构建、内联部件样式和注释指南

    CKEditor 5 v26.0.0 已经发布,本次更新包括支持创建一定制编辑器构建、Mac上按键管理、设计内联部件、编辑器占位符和一组关于使用协作特性注释新指南等内容。 通过 DLL

    精品推荐:历时7天,精心整理了16各领域全网盘搜索工具

    1.鸠摩搜书https://www.jiumodiary.com/一个强大搜书神站,无论是什么类型书籍,

    Apache Tomcat 10.0.4、9.0.44 和 8.5.64 发布

    Apache Tomcat 三分支发布了更新,分别是 10.0.4、9.0.44 和 8.5.64。 Tomcat 10.0.x 系列目标平台是 Jakarta EE 9。官方表示,Tomcat

    Java Web实战篇-代码之美

    代码之美-小小的优化让你代码Bug更少,执行效率更高

    精品推荐:大神总结十大 JavaScript 错误及如何规避

    通过统计数据库中1000多项目,我们发现在 JavaScript 中常出现错误有10。下面会向大家介绍这些错误发生原因以及如何防止。

    Linux 5.10.9 发布,小幅更新持续优化

    前几天,Linux 5.10.8 发布,最终解决了 Btrfs 性能问题。仅仅短短几天,5.10.9 也正式推出,相比上版本,此次更新幅度不大,主要聚焦于修复一些bug。 此次更新内容包含