Java的文档注释之生成帮助文档的实例
时间:2020-10-19 14:39:44|栏目:JAVA代码|点击: 次
示例:
/**
* Title: Person类<br/>
* Description:通过Person类说明Java中的文档注释<br/>
* Company: ***
* @author ***
* @version 1.0
*/
public class Person {
/**
* 这个是Person类的构造方法
* @param name Person 的名字
* */
public Person(String name) {
//执行语句;
}
/**
* 这是read()方法说明
* @param bookName 读的书的名字
* @param time 读书所用的时间
* @return 读的书的数量
* */
public int read(String bookName, int time) {
//执行语句;
return 1;
}
}
生成命令
person Mac$ javadoc -d . -version -author Person.java
注意Person.java路径名要正确。
效果:

其中index.html为主页,打开如下图:

上一篇:MyBatis_Generator插件的安装以及简单使用方法(图解)
栏 目:JAVA代码
本文标题:Java的文档注释之生成帮助文档的实例
本文地址:http://www.codeinn.net/misctech/13725.html


阅读排行
- 1Java Swing组件BoxLayout布局用法示例
- 2java中-jar 与nohup的对比
- 3Java邮件发送程序(可以同时发给多个地址、可以带附件)
- 4Caused by: java.lang.ClassNotFoundException: org.objectweb.asm.Type异常
- 5Java中自定义异常详解及实例代码
- 6深入理解Java中的克隆
- 7java读取excel文件的两种方法
- 8解析SpringSecurity+JWT认证流程实现
- 9spring boot里增加表单验证hibernate-validator并在freemarker模板里显示错误信息(推荐)
- 10深入解析java虚拟机




