Java运用Javadoc工具尝试导出帮助文档

最新推荐文章于 2022-09-21 15:28:32 发布

原创最新推荐文章于 2022-09-21 15:28:32 发布 · 221 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#Javadoc #API #帮助文档 #Java

API 专栏收录该内容

7 篇文章

订阅专栏

本文深入探讨了JavaDoc的使用方法及规范，包括类、构造器、方法等的注释方式，以及如何利用Javadoc工具生成帮助文档。通过具体代码示例，详细解释了文档注释的语法和作用。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

/**
 * 这是一个帮助文档的测试类，内容就是凑字数
 * @author caidawei - 作者
 * @since - 从哪个版本开始
 * @see	- 另外参见****类
 * 这是个这个类做解释，也不知道写什么，反正就是看着多
 * 
 */
public class JavaDocDemo {
	//单行注释
	/*
	 *多行注释 
	 */
	/**
	 * 文档注释-用来生成帮助文档
	 * 这是一个静态常量Normal等于10
	 */
	public final int Normal = 10;
	/**
	 * 这是一个无参构造器
	 */
	public JavaDocDemo(){
		
	}
	/**
	 * 这是一个传int值得构造器
	 * @param a - 这个a是什么意思，在这里做解释
	 */
	public JavaDocDemo(int a){
		
	}
	/**
	 * 这是一个用来复制数组的方法
	 * @param src 这是要复制的原数组
	 * @param offSrc 这是要复制原数组的起始位置
	 * @param dest 这是要复制的目标数组
	 * @param offDest 这是要复制的目标数组的起始位置
	 * @param length 这是要复制的元素个数
	 * @return	表示复制出来的新数组
	 */
	public int[] arrayCopy(int[] src,int offSrc,int[] dest,int offDest,int length){
		return null;
		
	}	
}

通过Javadoc工具导出帮助文档