javadoc是一种技术,它可以将注释信息生成帮助文档,类似于java的API
javadoc命令是用来生成自己的类的API文档的
在线的API帮助文档
内置很多类
文档注释 加在类的上面,就是类的注释 加在方法上面,就是方法的注释
文档注释加在方法上,自动帮助生成东西
自动帮你生成它的参数param,参数是一个名字 返回值没给你写
注解和注释的区别
先找到类的地址
选中当前类,右键——从文件夹中打开
通过命令行操作
最开始学了 javace 和 java
---------------------------------------------------------------------------------------------------------------------
现输入 javadoc 生成文档
设置编码,解决文档里中文 相当于用javadoc执行文件,加了一堆参数,再加文件名
javadoc -encoding UTF-8 -charset UTF-8 Doc.java
让它的编码为 UTF-8,让它的字符级编码也变为 UTF-8
javadoc和java命令一样,-encoding UTF-8 -charset UTF-8一堆参数为了让中文显示更正常,Doc.java文件
把Doc.java文件,编译成一份文档让人阅读
生成index.html 首页的意思
点进 Doc
Microsoft Windows [版本 10.0.19042.1415]
(c) Microsoft Corporation。保留所有权利。
C:\Users\L12\Desktop\Note\Demo1\Demo1\src\com\kuang\base>javadoc -encoding UTF-8 -charset UTF-8 Doc.java
正在加载源文件Doc.java...
正在构造 Javadoc 信息...
标准 Doclet 版本 1.8.0_311
正在构建所有程序包和类的树...
正在生成.\com\kuang\base\Doc.html...
Doc.java:15: 警告: @param 没有说明
* @param name
^
Doc.java:16: 警告: @return 没有说明
* @return
^
Doc.java:25: 警告: @param 没有说明
* @param name
^
Doc.java:26: 警告: @return 没有说明
* @return
^
Doc.java:27: 警告: @throws 没有说明
* @throws Exception
^
正在生成.\com\kuang\base\package-frame.html...
正在生成.\com\kuang\base\package-summary.html...
正在生成.\com\kuang\base\package-tree.html...
正在生成.\constant-values.html...
正在构建所有程序包和类的索引...
正在生成.\overview-tree.html...
正在生成.\index-all.html...
正在生成.\deprecated-list.html...
正在构建所有类的索引...
正在生成.\allclasses-frame.html...
正在生成.\allclasses-noframe.html...
正在生成.\index.html...
正在生成.\help-doc.html...
5 个警告
C:\Users\L12\Desktop\Note\Demo1\Demo1\src\com\kuang\base>
package com.kuang.base; /** * @author Kuangshen * @version 1.0 * @since 1.11 * */ //这一段文档注释 是加在类上的。除了类,文档注释还可以加在方法上。 public class Doc { String name; //定义一个变量,在类里面定义的变量,叫做类变量 //(属性) /** * * @param name * @return */ public String test(String name){ //方法名字叫test,参数为String name return name; //(方法) } /** * @author Kuangshen * * @param name * @return * @throws Exception */ //文档注释会自动说 这个方法会抛出异常,上面可自行修改 public String test1(String name) throws Exception{ //更多的操作:抛出一个异常 return name; } //kuangshen是通过命令行 javadoc 参数 Java文件 //学会查找使用IDEA生成JavaDoc文档! 面向百度编程!或者问群 群体,志同道合的人在一块儿 //基础部分的一切知识,后面几乎每天都会用 //下章——方法、流程控制 可以写一个简单的计算器 }