这一节学习了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.
......
*/
- 前言
- 1.1 基本常识
- 1.2 Java语言概述
- 1.3 Java语言的环境搭建
- 1.4 Java程序开发之初体验--Hello World
- 2.1 关键字
- 2.2 标识符
- 2.3 注释
- 2.4 常量
- 2.5 进制扫盲
- 2.6 变量和数据类型(1)
- 2.7 变量和数据类型(2)
- 2.8 运算符
- 3.1 if语句
- 3.2 switch语句
- 3.3 while和do-while语句
- 3.4 for语句
- 3.5 for循环的嵌套
- 3.6 break语句与continue语句
- 4.1 函数的定义
- 4.2 定义函数的两个明确
- 4.3 函数的内存加载过程
- 4.4 函数的重载
- 5.1 数组的定义
- 5.2 数组的内存分配及特点
- 5.3 数组操作中常见问题
- 5.4 数组常用操作(1)
- 5.5 数组常用操作(2)
- 5.6 二维数组
- 6.1 面向对象的概述
- 6.2 类与对象的关系
- 6.3 对象的内存体现
- 6.4 成员变量与局部变量
- 6.5 类类型参数与匿名对象
- 6.6 基本数据类型参数与引用数据类型参数的传递过程
- 6.7 封装
- 7.1 构造函数概述与默认构造函数
- 7.2 构造函数与一般函数的区别
- 7.3 构造函数的重载
- 7.4 构造函数的内存加载
- 7.5 构造函数需要注意的几个细节
- 7.6 this关键字的原理
- 7.7 this关键字的细节与应用
- 8.1 static关键字之特点
- 8.2 成员变量与静态变量的区别
- 8.3 static关键字使用的注意细节
- 8.4 main函数的解析与细节
- 8.5 static关键字的使用场景
- 8.6 静态的内存加载
- 8.7 静态代码块
- 8.8 构造代码块
- 9.1 继承
- 9.2 单继承与多重继承
- 9.3 子父类中成员变量特征体现