javadoc注释文档
javadoc命令式用来生成自己的API文档的
参数信息
- @author 作者名 *
- @version 版本号*
- @since 指明需要最早使用的JDK版本
- @param 参数名
- @return 返回值情况
- @thorw 异常抛出情况
一般只需要会写作者名跟版本号就好了。
package com.ckw.blog.base;
/**
* @author :ckk
* @version 版本
* @since 指明需要最早使用的JDK版本
* @param 参数名
* @return 返回值情况
* @thorw 异常抛出情况
*/
public class demoJavadoc {
String name;
/**
* @param name
* @return
* @throws Exception
*/
public String test(String name) throws Exception{
return name;
}
}
加在类上面就是类的注释
加在方法就是方法的注释
cmd指令
javadoc -encoding UTF-8 -charset UTF-8 doc.java
可以用idea生成java.doc。百度搜索
javadoc 参数 file.java
三个cmd java指令
javac file.java 编译文件
java file 运行编译文件(必须编译后才可以执行)
javadoc file.java 生成java的API文档
基础回顾
- 注释,标示符,关键字
- 数据类型
- 类型转换
- 变量,常量
- 运算符
- 包机制,JavaDoc