文章目录
- java 的注释共有三种形式
- 单行注释
- 多行注释
- 文档注释
- 文档注释的文档需要命令进行生成
- GBK 不可映射问题
与大多数的编程语言一样，Java 中的注释也不会出现在可执行程序中。
因此我们可以在源程序中根据需要添加任意多的注释，而不必担心可执行代码受到任何影响。
java 的注释共有三种形式
单行注释
最常用的是单行注释，在需要注释的内容前 加上 //。
其注释内容从 // 开始到本行末尾
System.out.println("Hello_World"); //HelloWorld的输出语句
多行注释
当需要更长的注释时，则可以使用 /* 多行注释 */
/*
我是一个Java 小白，
这是我开始学习Java接触的第一个程序：HelloWorld
*/
System.out.println("Hello_World");
文档注释
文档注释，意如其名，可以生成文档。这种注释以 /** 开始，以 */ 结束。
/**
* 我是兔C，我开始学习Java，
* 这是我编写的第一个Java程序。
*/
public class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello_world!");
}
}
文档注释的文档需要命令进行生成
用上述的demo举例：
打开控制台，路径选择在示例代码的所在路径。
生成文档的命令：
javadoc 文件名.java
GBK 不可映射问题
windows 系统的默认编码为 GBK。
而我们代码编辑工具的默认编码 一般为 UTF-8。
统一两者的编码格式即可编译通过。
其实想解决 当前的不可映射，有两种解决方式，前一种是贴合系统去改。
-
贴合系统改你的代码编辑工具，或者改当前要运行 命令行命令的文件编码。
-
我选择第二种，让 windows 贴合我的使用习惯
打开电脑的系统设置，在找到语言设置区域的 更改系统区域设置，打开后勾选对 UTF-8编码格式的支持。如图：
设置完成后会重启计算机，提示一下，做好准备。
我重启完了。。
在从新输入一下命令。
javadoc -d F:My_JavaCode\src\Demo1 -encoding UTF-8 文件名.java
//-d 参数，是添加一个文档生成后的存储位置
//-encoding 参数，是设置一下编码格式，防止无法识别中文
运行完之后，会在你设置好的存储路径下生成一坨坨文件。
我们通过浏览器打开这个选中的首界面，就可以查看生成的相关文档
