/**
文档注释 javadoc所解析时,需要在类前面加上public
@author ltx
@version v1.0
this is my first procedure
*/
public class hellotx{
//单行注释:如下的main方法是程序的入口
/*多行注释
注释是给别人看的
1.java规范了三种注释方式
(1)单行注释
(2)多行注释
(3)文档注释(java特有):注释内容可以被javadoc所解析
2.单行注释和多行注释的作用:
(1)对所写的程序进行解释说明,增强可读性,方便给别人看的,也方便给自己看
(2)调试所写的代码
3.单行注释和多行注释 ,注释的内容不参与编译,编译以后生成的class结尾的字节码文件中不包含注释掉的信息
*/
public static void main(String[] args){
System.out.println("hello tx");
}
}
今天文档注释所遇到的问题:
当编译java文件时,出现以下乱码信息
hellotx.java:2: 错误: 编码GBK的不可映射字符
鏂囨。娉ㄩ噴 javadoc鎵?瑙f瀽鏃讹紝闇?瑕佸湪绫诲墠闈㈠姞涓妏ublic
^
hellotx.java:2: 错误: 编码GBK的不可映射字符
鏂囨。娉ㄩ噴 javadoc鎵?瑙f瀽鏃讹紝闇?瑕佸湪绫诲墠闈㈠姞涓妏ublic
^
hellotx.java:11: 错误: 编码GBK的不可映射字符
1.java瑙勮寖浜嗕笁绉嶆敞閲婃柟寮?
^
hellotx.java:12: 错误: 编码GBK的不可映射字符
锛?1锛夊崟琛屾敞閲?
^
.......
解决方法:
用记事本软件打开Java文件,选择另存为ANSI类型,保存后在使用DOS编译即可通过
命令:
javac hellotx.java
javadoc -d 自己所创建文件夹名称 -author -version hellotx.java
即可成功生成文档文件夹
如下:
D:codeday02>javac hellotx.java
D:codeday02> javadoc -d myjava -author -version hellotx.java
正在加载源文件hellotx.java...
正在构造 Javadoc 信息...
正在创建目标目录: "myjava"
标准 Doclet 版本 1.8.0_221
正在构建所有程序包和类的树...
正在生成myjavahellotx.html...
正在生成myjavapackage-frame.html...
正在生成myjavapackage-summary.html...
正在生成myjavapackage-tree.html...
正在生成myjavaconstant-values.html...
正在构建所有程序包和类的索引...
正在生成myjavaoverview-tree.html...
正在生成myjavaindex-all.html...
正在生成myjavadeprecated-list.html...
正在构建所有类的索引...
正在生成myjavaallclasses-frame.html...
正在生成myjavaallclasses-noframe.html...
正在生成myjavaindex.html...
正在生成myjavahelp-doc.html...