Java的文档注释之生成帮助文档的实例
更新时间:2017年12月14日 09:06:01 作者:gdwkong
下面小编就为大家分享一篇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为主页,打开如下图:

以上这篇Java的文档注释之生成帮助文档的实例就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持脚本之家。
相关文章
springcloud如何使用dubbo开发rpc服务及调用
这篇文章主要介绍了springcloud如何使用dubbo开发rpc服务及调用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2020-01-01
SpringBoot3.x中spring.factories SPI 服务发现机制的改变问题小结
spring.factories其实是SpringBoot提供的SPI机制,底层实现是基于SpringFactoriesLoader检索ClassLoader中所有jar引入的META-INF/spring.factories文件,这篇文章主要介绍了SpringBoot3.x中spring.factories SPI 服务发现机制的改变,需要的朋友可以参考下2023-05-05
Servlet3.0学习总结之基于Servlet3.0的文件上传实例
本篇文章主要介绍了Servlet3.0学习总结之基于Servlet3.0的文件上传实例,具有一定的参考价值,有兴趣的可以了解一下2017-07-07


最新评论