Java的文档注释之生成帮助文档的实例
程序员文章站
2023-12-09 14:47:21
示例:
/**
* title: person类
* description:通过person类说明java中的文档注释
* description:通过person类说明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的文档注释之生成帮助文档的实例就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持。
推荐阅读
-
Java基于状态模式实现的文档编辑模式切换功能实例
-
java使用dom4j生成与解析xml文档的方法示例
-
使用Doxygen生成全中文的chm、pdf帮助文档的方法
-
使用apidocJs快速生成在线文档的实例讲解
-
java使用dom4j生成与解析xml文档的方法示例
-
FreemarkerJavaDemo【Android将表单数据生成Word文档的方案之一(基于freemarker2.3.28,只能java生成)】
-
java 帮助文档的制作javadoc
-
三种Java打印PDF文档的实例代码
-
Python自动化之批量生成含指定数据的word文档
-
JAVA基于OPENXML的word文档插入、合并、替换操作系列之html转word