下面是 网友针对“你看到过的最好的代码注释是什么样的?”这个问题给出的回答的前10条: 1. // 亲爱的维护者: // 如果你尝试了对这段程序进行‘优化’, // 并认识到这种企图是大错特错,请增加 // 下面这个计数器的个数,用来对后来人进行警告: // 浪费在这里的总时间 = 39h 2. /** * 致终于来到这里的勇敢的人: 你是被上帝选中的人,英勇的.不辞劳苦的.不眠不修的来修改 我们这最棘手的代码的编程骑士.你,我们的救世主,人中之龙, 我要对你说:永远不要放弃,永远不要对自己失望…

Java技术栈 www.javastack.cn 优秀的Java技术公众号 作者:Blankj https://github.com/Blankj/awesome-comment 写在前面的话:一时兴起就收集了以下神注释,希望能为广大ITer带来快乐,缓解你们工作中的压力,下面开车,先自爆头像,下文会给出制作链接. 备注:文中字符均可以直接复制直接用! /***  * 瓦瓦 十  * 十齱龠己 亅瓦車己  * 乙龍龠毋日丶 丶乙己毋毋丶  * 十龠馬鬼車瓦 己十瓦毋毋  * 鬼馬龠馬龠十 己己毋…

备注:文中字符均可以直接复制直接用! 再补上一个好玩的网站 Ascii World:(链接:http://www.asciiworld.com/). 网站上的图形很多,感兴趣的可以复制链接到浏览器上打开: /*** * 瓦瓦 十 * 十齱龠己 亅瓦車己 * 乙龍龠毋日丶 丶乙己毋毋丶 * 十龠馬鬼車瓦 己十瓦毋毋 * 鬼馬龠馬龠十 己己毋車毋瓦 * 毋龠龠龍龠鬼乙丶丶乙車乙毋鬼車己 * 乙龠龍龍鬼龍瓦 十瓦毋乙瓦龠瓦亅 * 馬齱龍馬鬼十丶日己己己毋車乙丶 * 己齱馬鬼車十十毋日乙己己乙乙 * 車…

前言 首先这个文档中主要记述了自己在编写html代码时如何构建良好的dom结构的一些所思所想,在这一部分主要说明按“块”构建dom结构的思路.同时在这篇文档中也记述了自己对代码注释的理解,在这一部分主要说明注释对理解代码结构的重要性和提高团队配合的重要性出发来说明,因为之前有一段时间的工作属于在“一直修改和维护别人代码”或者说把别人项目的其中一部分独立开来成为一个项目,在这个过程中我渐渐对代码注释的重要性是深有体会的! 当然了,这些可能是我自己的理解,并不是最优的,所以没必要在自己的项目开发过程…

定义函数 Kotlin定义一个函数的风格大致如下 访问控制符 fun 方法名(参数,参数,参数) : 返回值类型{ ... ... } 访问控制符:与Java有点差异,Kotlin的访问范围从大到小分别是public.internal.protected.private,不声明默认是public: 返回值类型:不需要返回类型的函数,后面的 : 返回值类型可以缺省(这里可以看到无论是变量还是方法,Kotlin都喜欢名字在前,类型在后): /***Kotlin版代码***/ //有返回参数的函数 f…

最近经常做业务逻辑代码review的工作,发现各种风格的代码,其中有一种是封装和抽象做的非常的多,代码层次非常的深入,表面给人感觉是:牛逼的代码. 但是从清晰度和可维护性来说,还是不推荐这么做. 1.这种代码出现问题后,很难定位哪里出现问题; 2.后续别人维护起来也相当困难; 3.每看一个简单的case,都要跟踪很久; 4.写UT(单元测试)也相当麻烦 我个人认为编写业务逻辑代码还是要从可读性入手,轻松的能看懂代码,如果代码有问题,可以快速定位和修复.我们又不是做底层框架编写,要追求各种设计和扩…

在 python改变世界,从hello world开始 中我们已经完成了第一个python程序,代码是有了,关键是好像好不知道写的啥玩意? 一.什么是代码注释 代码注释就是给一段代码加上说明,表明这段代码的作用或者实现的功能,方便别人阅读代码.打个形象的比喻: 问题来了,那个女孩是谁?张三?李四?王五? 加上注释再来一遍:放开小红.大家就都明白了,这个女孩叫小红. 二.为什么写代码要注释 IT圈有一个梗:当我写这段代码的时候,只有上帝和我知道,现在,只有上帝知道.上帝说:这个锅我不背!   IT…

obert C. Martin写的<Clean Code>是我读过的最好的编程书籍之一,若没有读过,推荐你将它加入书单. 注释就意味着代码无法自说明 —— Robert C. Martin Martin在文中详细讨论了代码注释,我不会完全重复他的话.简而言之,他的意思就是,这些注释是注定会过时的.程序执行时会忽视注释,所以无法保证这些说明注释会准确的描述代码作用.所以最好的方式是让代码自说明,如此,按照代码逻辑,程序员和程序获取到的信息是一致的. 思考如下代码: // Check to see…

java代码注释规范   代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率.也是程序代码可维护性的重要环节之一.所以我们不是为写注释而写注释.下面说一下我们在诉求网二期开发中使用的代码注释规范,供大家参考下. 原则: 1.注释形式统一 在整个应用程序中,使用具有一致的标点和结构的样式来构造注释.如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范. 2.注释内容准确简洁 内容要简单.明了.含义准确,防止注释…

PHPDocument 代码注释规范 1. 安装phpDocumentor(不推荐命令行安装)在http://manual.phpdoc.org/下载最新版本的PhpDoc放在web服务器目录下使得通过浏览器可以访问到点击files按钮,选择要处理的php文件或文件夹还可以通过该指定该界面下的Files to ignore来忽略对某些文件的处理.然后点击output按钮来选择生成文档的存放路径和格式.最后点击create,phpdocumentor就会自动开始生成文档了. 2．如何写PHP规范注…