浅谈Java的注释(一)

这篇文章将从以下几个方面来谈谈Java的注释:
1、为什么要添加程序注释
2、注释的用途
3、单行注释和多行注释的语法
4、文档注释的语法以及常用的Javadoc标记
5、Javadoc命令的用法
好,下面就将一一总结

一、为什么要添加程序注释
至少有如下三个方面来考虑

1、当你下次再看到这段代码时,要想找到当初编写这段代码时的思路,建议添加注释

2、在团队协作开发过程中,一个人写得代码要想被团队中的其他人所理解,建议添加注释,从而可以利于整个团队成员之间的沟通

3、代码即文档,实际上程序源代码是程序文档的重要部分,当我们把各种软件相关文档写规范时,不要忘记把程序里最重要的文档:源代码写规范


二、注释的作用

1、注释最重要就是起到说明的作用

2、添加注释也是调试程序的一个重要方法。如果我们觉得某段代码有问题,可以采用注释方式将其注释起来,再编译、运行,如果发生同样的错误,则说明错误不是由我们注释起来的代码产生的。如果该错误不再发生,则说明错误是由我们注释起来的代码产生的,这样就缩小了错误所在的范围


三、单行注释和多行注释的语法

1、单行注释就是再程序中注释一行代码,在Java中用(//)放在需要注释的内容之前就可以

2、多行注释就是一次性的将代码中的多行注释掉,在Java中用(/*注释内容 */)来表示
阅读更多
想对作者说点什么? 我来说一句

没有更多推荐了,返回首页