注释并不会被执行,是给我们写代码的人看的
1.单行注释
单行注释的文字颜色设置
2.多行注释
多行注释文字颜色设置
3.文档注释
Java文档注释的主要作用是为代码提供详细的说明和描述,以便于其他开发人员理解和使用。具体来说,其作用包括:
- 提供代码的功能说明:通过文档注释,可以清晰地描述代码的作用、功能以及使用场景,帮助其他开发人员快速理解代码的设计意图。
- 辅助生成API文档:Java文档注释可以被Javadoc工具解析,生成HTML格式的API文档。这些文档包含了类的说明、方法的参数、返回值以及异常等信息,是软件开发中不可或缺的一部分。
- 提高代码的可维护性:详细的文档注释可以让后续的维护人员更容易地理解代码的逻辑和结构,从而降低维护成本和提高维护效率。
综上所述,Java文档注释在软件开发中扮演着重要的角色,它不仅是代码的一部分,更是软件开发团队协作和沟通的桥梁。
4.神注释(有趣的代码注释)
比如这里有一只皮卡丘
/*
quu..__
$$$b `---.__
"$$b `--. ___.---uuudP
`$$b `.__.------.__ __.---' $$$$" .
"$b -' `-.-' $$$" .'|
". d$" _.' |
`. / ..." .' |
`./ ..::-' _.' |
/ .:::-' .-' .'
: ::''\ _.' |
.' .-. .-. `. .' |
: /'$$| .@"$\ `. .' _.-'
.'|$u$$| |$$,$$| | < _.-'
| `:$$:' :$$$$$: `. `. .-'
: `"--' | `-. \
:##. == .###. `. `. `\
|##: :###: | > >
|#' `..'`..' `###' x: / /
\ xXX| / ./
\ xXXX'| / ./
/`-. `. / /
: `- ..........., | / .'
| ``:::::::' . |< `.
| ```| x| \ `.:``.
| .' /' xXX| `:`M`M':.
| | ; /:' xXXX'| -'MMMMM:'
`. .' : /:' |-'MMMM.-'
| | .' /' .'MMM.-'
`'`' : ,' |MMM<
| `' |tbap\
\ :MM.-'
\ | .''
\. `. /
/ .:::::::.. : /
| .:::::::::::`. /
| .:::------------\ /
/ .'' >::' /
`',: : .'
`:.:'
*/