首页 » 排名链接 » 1:自己写注释,2:别人不写注释(注释程序员代码件事最讨厌)

1:自己写注释,2:别人不写注释(注释程序员代码件事最讨厌)

少女玫瑰心 2024-11-24 11:01:25 0

扫一扫用手机浏览

文章目录 [+]

为什么这样说呢?来先看一段代码,代码层面加了很清晰的注释来解释这段代码为什么这么写,使看的人引发思考,便于理解,不知不觉间会产生一种亲切感有木有~

注释的分类:

1.单行注释

1:自己写注释,2:别人不写注释(注释程序员代码件事最讨厌) 排名链接
(图片来自网络侵删)

以//双斜杠后面加上要描述的注释信息

这是最简单的注释方式了,特别是在定义变量时,尤其重要,当程序代码块较长时;经常会出现一些相似命名的变量,这时候为不同的变量加以说明会起到非常重要的作用。

2.多行注释

/

/

类似于这种以斜杠后跟一个星号组成的代码块为多行注释,一般用于描述代码块中一段复杂的业务逻辑说明,或对代码的解释。

多行注释相比较而言比较鸡肋,用的地方并不多。

3.文档注释(最重要的注释了)

我们阅读源码时,经常会看到大块大块的注释,一般用于类,方法上对作者,版本,功能,出入参进行一个解释,当别的代码引用时,就可以看到代码清晰的功能解释和出入参。

这种注释可以用于javadoc生成api文档,理解就好,一般用不到。

重点来了,在日常开发中最苦恼的事是什么呢?同事离职代码交接,大段大段的一个注释都没有,完全找不到切入点,这种苦恼的心情,真的是叫天天不应,叫地地不灵啊。

新员工的感触一定是最深的。

大家来感触一下,如果不会点英文,感觉在读天书。

那么道理都懂,可为什么还是过不好这一生?拿我自己的感觉,我自己在开发时感觉自己写的代码都很简单,思路如泉涌,需要写注释吗?还有其实内心深入有一种排斥感,为什么会这样呢?可能是有以下几点原因:

1.写一行注释就感觉是在浪费时间

2.这么见名知义的代码,根本不需要写

3.得过且过,自己就在这里待一年多,大不了就走呗

4.这样看起来应该很牛X

好啦,本着为人为已,百利而无一害的原则,劝新入行的程序员一定要认真地写好注释。
一本书上曾提到注释的量,约占整个程序的20%~50%,这可是清华大学出版的,《Java从入门到精通里》,可见注释的重要性了。

持续打造精品、优质、计算机专业知识,想听什么就留言吧,咱们明天见。

标签:

相关文章