在编写代码的时候,良好规范的注释可以增加代码的可读性和可维护性,Java中的注释大概分成四类,下面就分别介绍下
打开我们的eclipse,以一份Java代码为例,单行注释用//表示,快捷键CTRL+/
然后是多行注释,也叫块注释,用/*..*/表示,快捷键CTRL+SHIFT+/
文档注释,一般是代码的说明文档,用/**..*..*..*/表示,快捷键/**+enter
标签注释,用@+alt+/补齐,比如author,说明代码的作者
Java注释的三种方式:单行、多行和文档
通常我们需要在源代码中添加文字用来对进行代码解释说明,但这些文字并不是 Java 代码的语法,会导致编译出错。这时我们可以使用注释来完成这一事项!
在编译时,编译器会忽略注释的存在,就好像注释内容不存在一样。所以注释并不会导致编译出错,同时注释还方便编写者和其他人阅读源代码,加强对代码的理解。
Java中提供了三种注释方式:
(1)单行注释: // 注释内容
快捷键:【注释 ctrl / 】 、 【 取消注释 ctrl / 】
单行注释
(2)多行注释 /* 注释内容 */
快捷键:【注释 ctrl shift / 】 【取消注释 ctrl shift \ 】
多行注释
(3)文档注释 /** 注释内容 */
文档注释和多行注释的作用基本相同,唯一的区别时文档注释可以使用javadoc.exe命令生成API文档。
建议写代码的时候先写思路,分析,步骤,然后再写代码。思路,分析,步骤使用注释放在源代码中。
文本注释
为什么要添加程序注释?
(1)用于不要过于相信自己的理解能力!
(2)可读性第一,效率第二,软件开发需要团队合作,一个人写的代码需要被整个团队的其他人理解,
所以注释是必要的。
(3)代码即文档,程序源代码是程序文档的重要组成部分。软件里最重要的文档:源代码写规范。