2.3 注释

这一节学习了java程序的注释。 代码注释是架起程序设计者与程序阅读者之间的通信桥梁，最大限度的提高团队开发合作效率，如果说一个项目开发过程中项目组成员发生变动了，对于新来的成员很有帮助。也是程序代码可维护性的重要环节之一。 所以我们不是为写注释而写注释。 首先讲注释的类型 继续用1.4节的HolleWorld.java程序为例 ~~~ /** ------------------------------------------------>这是文档注释 这个类是用于演示hello world. */ class HelloWorld{//-------------------------->这是单行注释 /* ------------------------------------------->这是多选注释 这是多行注释 main函数可以保证该类的独立运行. 它是程序的入口. 它会被JVM所调用 */ public static void main(String[] args){ System.out.println("Hello World!"); } } ~~~ 从上面的代码和注释可以看到，java语言中的注释主要可以分为三类 1.单行注释： //   2.多选注释（也称为块注释）： /* */ 3.文档注释：这个很重要，是java特有的注释，自动生成文档 /** */ 4.javadoc 注释标签语法大体有以下几种 @author 对类的说明标明开发该类模块的作者 @version 对类的说明标明该类模块的版本 @see 对类、属性、方法的说明参考转向，也就是相关主题 @param 对方法的说明对方法中某参数的说明 @return 对方法的说明对方法返回值的说明 @exception 对方法的说明对方法可能抛出的异常进行说明 javadoc可以帮助生成一个说明书,这个网页文档是给开发人员用的 注释是不被编译到class字节码中. 注释的作用:1注解说明;调试使用. 再来说下注释的应用 在编程之前我们不要急着就开始编码，先想一想我们要做什么，理一理我们应该怎么做，可以在编码之前用注释来记录我们需求，思路，步骤等等，让我们形成思考的好习惯。 /* 需求: 思路: 1. 2. ...... 步骤: 1. 2. ...... */