程序员最讨厌的两件事,1:自己写注释,2:别人不写注释
⭐发布日期:2024年10月10日 | 来源:中国军网
【2024新澳门今天晚上开什么生肖】 |
【澳门4949精准免费大全】 |
【最新二四六大全免费资料大全】 | 【二四六香港天天开好彩】 | 【2024年新奥开奖结果】 | 【新澳天天开奖资料大全最新】 | 【新澳资彩长期免费资料】 | 【2024天天开好彩大全183期】 | 【2024新澳天天彩资料】 | 【2024年澳门内部资料】 |
【新澳门2024年资料版本】 | 【2024噢门天天开好彩大全】 | 【2024澳彩管家婆资科】 | 【新澳精准资料免费提供濠江论坛】 | 【新澳精选资料免费提供】 | 【新澳门免费咨料】 | 【2024年新澳门开奖号码】 | 【2024天天开好彩大全】 |
当了这么多年程序员,才懂得细节是评价一名优秀程序员的重要参考标准。
为什么这样说呢?来先看一段代码,代码层面加了很清晰的注释来解释这段代码为什么这么写,使看的人引发思考,便于理解,不知不觉间会产生一种亲切感有木有~
注释的分类:
1.单行注释
以//双斜杠后面加上要描述的注释信息
这是最简单的注释方式了,特别是在定义变量时,尤其重要,当程序代码块较长时;经常会出现一些相似命名的变量,这时候为不同的变量加以说明会起到非常重要的作用。
2.多行注释
/*
*
*/
类似于这种以斜杠后跟一个星号组成的代码块为多行注释,一般用于描述代码块中一段复杂的业务逻辑说明,或对代码的解释。
多行注释相比较而言比较鸡肋,用的地方并不多。
3.文档注释(最重要的注释了)
我们阅读源码时,经常会看到大块大块的注释,一般用于类,方法上对作者,版本,功能,出入参进行一个解释,当别的代码引用时,就可以看到代码清晰的功能解释和出入参。
这种注释可以用于javadoc生成api文档,理解就好,一般用不到。
重点来了,在日常开发中最苦恼的事是什么呢?同事离职代码交接,大段大段的一个注释都没有,完全找不到切入点,这种苦恼的心情,真的是叫天天不应,叫地地不灵啊。
新员工的感触一定是最深的。
大家来感触一下,如果不会点英文,感觉在读天书。
那么道理都懂,可为什么还是过不好这一生?拿我自己的感觉,我自己在开发时感觉自己写的代码都很简单,思路如泉涌,需要写注释吗?还有其实内心深入有一种排斥感,为什么会这样呢?可能是有以下几点原因:
1.写一行注释就感觉是在浪费时间
2.这么见名知义的代码,根本不需要写
3.得过且过,自己就在这里待一年多,大不了就走呗
4.这样看起来应该很牛X
好啦,本着为人为已,百利而无一害的原则,劝新入行的程序员一定要认真地写好注释。一本书上曾提到注释的量,约占整个程序的20%~50%,这可是清华大学出版的,《Java从入门到精通里》,可见注释的重要性了。
持续打造精品、优质、计算机专业知识,想听什么就留言吧,咱们明天见。
【2024澳门天天开好彩大全免费】 【新澳天天开奖资料大全最新】 |
【2024年天天开好彩资料】 【新澳天天开奖资料大全最新54期】 |
【2024澳门天天开好彩大全53期】 【澳门天天开彩期期精准】 |
【2024全年资料免费大全】 【新澳天天开奖资料大全】 |
【澳门内部最精准免费资料】 【2024澳门天天开好彩大全】 |
【2024年新奥门天天开彩免费资料】 【新澳2024今晚开奖资料】 【2024澳门正版资料免费】 |
发表评论
肖恩·劳伦斯
5秒前:这种注释可以用于javadoc生成api文档,理解就好,一般用不到。
IP:14.38.1.*
弗雷德·多尔顿·汤普森
5秒前:拿我自己的感觉,我自己在开发时感觉自己写的代码都很简单,思路如泉涌,需要写注释吗?
IP:94.59.1.*
韩智俊
8秒前:同事离职代码交接,大段大段的一个注释都没有,完全找不到切入点,这种苦恼的心情,真的是叫天天不应,叫地地不灵啊。
IP:83.45.5.*