- 平时我们编写代码,在代码量比较少的时候,我们还可以看懂自己写的,但是当项目结构一旦复杂起来,我们就需要用到注释了。
- 注释并不会被执行,是给我们写代码的人看的
- 书写注释是一个非常好的习惯
- 平时写代码一定要注意规范。
Java中的注释有三种:
- 单行注释 // 注释,只能注释一行文字
- 多行注释 /* 注释,可以注释一段文字 */
- 文档注释 /** 注释 */
JavaDoc:文档注释
/**
* @Description HelloWorld
* @Author 实习生-苏进
*
* @Description ---》 描述
* @Author ---》 作者
*/
有趣代码注释 | 神代码注释 ↓↓↓
/**
* _ooOoo_
* o8888888o
* 88" . "88
* (| -_- |)
* O\ = /O
* ____/`---'\____
* . ' \\| |// `.
* / \\||| : |||// \
* / _||||| -:- |||||- \
* | | \\\ - /// | |
* | \_| ''\---/'' | |
* \ .-\__ `-` ___/-. /
* ___`. .' /--.--\ `. . __
* ."" '< `.___\_<|>_/___.' >'"".
* | | : `- \`.;`\ _ /`;.`/ - ` : | |
* \ \ `-. \_ __\ /__ _/ .-` / /
* ======`-.____`-.___\_____/___.-`____.-'======
* `=---='
*
* .............................................
* 佛祖保佑 永无BUG
*/