为什么要写注释
在我们编程写代码的时候,除了写代码,有时还需要写注释。代码是写给机器看的,也是写给人看的,但是有的时候,代码写的不是很明白,一般人会看不懂,不知道这个是啥意思,为什么要这么做。 这个时候,就需要写注释,告诉后面看代码的人,这里为什么要这么写,不这样写行不行。
一般的代码文件里,都会有很多注释,一般公司对这方面也会有要求,注释率必须达到20%或者更高。一般人写完代码,等别人来看的时候,很多时候都看不懂,有时甚至,几天之后,自己都看不懂当时为什么这么做了,所以注释就非常重要了。
Java注释总共分为三类:
- 单行注释
- 多行注释
- 文档注释
采用//开头,如:
//下面这个方法用来实现人工智能***,不要随便修改。
采用/*开头,*/结束,如:
/*
我也不想写这么复杂的方法,但是产品经理要求这样做。
真的是没办法,程序员真的是太难了。
*/
采用/**开头,*/结束,如:
/**
* 我最喜欢的妹子昨天结婚了,我很伤感。
* 为了冲淡一下感觉,我决定先写一天的代码,看看会不会好一些。
* @author 十代码农
*/