广州番禺Python, Java小班周末班培训
第四期线下Java, Python小班周末班已经开课了，培训的课程有Python爬虫，Python后端开发，Python办公自动化，Python大数据分析, Java中高级工程师培训。授课详情请点击：http://chipscoco.com/?cate=6
5.4.1 代码注释
在程序的编写过程中，通常会写注释，用来对关键的代码或程序中复杂的逻辑进行描述。代码注释面向的是程序员，也就是说它是给程序员看的。Java在执行的过程中 ，会跳过代码中的注释内容。
同学们在一开始学习编程的时候，就要养成写代码注释的习惯，将程序中关键的逻辑通过文字描述记录下来，这样在以后阅读的过程中，可以通过注释来理解程序中的关键逻辑。也不要过度注释，否则会影响代码的整体可读性。
5.4.2 单行注释
单行注释，顾名思义，注释的内容仅为一行。在Java中使用两个斜杠符号//来作单行注释。
//后面一般会加一个空格，以下是使用单行注释的代码实例：
public class HelloJava {
public static void main(String[] args) {
// 定义整型变量number，初始化为6
int number = 6;
System.out.println(numbers);
}
}单行注释也可以写到语句的末尾：
public class HelloJava {
public static void main(String[] args) {
int number = 6; // 定义整型变量number
System.out.println(number);
}
}5.4.3 多行注释
单行注释仅能注释一行，当需要注释多行内容时，可使用多行注释。在 Java中使用/**/符号 来编写多行注释，注释的内容写在/*与*/之间。编写多行注释时，一般首行和尾行不写注释信息，以下是使用多行注释的代码实例：
public class HelloJava {
public static void main(String[] args) {
/*
(1) 定义整型变量number,初始化为6
(2) 通过System.out.println方法来输出变量的值
*/
int number = 6;
System.out.println(number);
}
}5.4.4 文档注释
文档注释以/**开始，以*/结尾，用来对文档的属性信息，类、接口的描述信息进行注释。在Java中可通过javadoc工具将文档注释输出为 HTML文档 。常见的文件头注释就是文档注释 ，在文件头注释中写明作者姓名，文档日期 ，版本号等。文档注释的代码实例：
/**
* @author 薯条老师
* @date 2021-11-08
* @version 1.0
*/
public class HelloJava {
public static void main(String[] args) {
// 定义整型变量number
int number = 6;
// 输出整型变量number的值
System.out.println(number);
}
}5.4.5 注释规范
变量命名有其规范，在程序中编写注释也需要遵守规范。规范的注释写法会让程序更可读且美观，同学们先来看一个注释使用不太好的例子：
public class HelloJava {
public static void main(String[] args) {
int number = 6; // 定义整型变量number
// 输出整型变量number的值
System.out.println(number);
}
}以上的注释风格没有保持统一，第一个注释写在语句末尾，第二个注释写在代码的上一行。在团队开发中，通常将注释内容统一写在目标代码的上一行：
public class HelloJava {
public static void main(String[] args) {
// 定义整型变量number
int number = 6;
// 输出整型变量number的值
System.out.println(number);
}
}除了统一的注释形式，程序员还应当注意注释内容的简洁和可读性，避免繁琐和冗长。也不要滥加注释，除基本注释之外 ，只对关键代码，较难理解的代码编写注释。这里的基本注释包含文件头注释，全局变量的注释，函数头注释等，在后面讲解Java的类结构时会再进行详细讲解。
5.2.6 课后习题
(1) 一个简单的问题：为什么程序在执行时会忽略注释？
(2) 一个严肃的问题：为什么你要写注释？为什么你不写注释？
(3) 简述你对规范的理解，例如变量的命名规范，代码的注释规范。
