Question

java api接口文档编写

是不是指编写一个类似于jdk帮助文档那样的东西啊，
把方法，属性的 功能，参数什么的都写上去？
是的话 有没有什么模板啊！ 在网上都搜不到

Answer 1

Java语言提供了一种强大的注释形式：文档注释。可以将源代码里的文档注释提取成一份系统的API文档。我们在开发中定义类、方法时可以先添加文档注释，然后使用javadoc工具来生成自己的API文档。

文档注释以斜线后紧跟两个星号（/**）开始，以星号后紧跟一个斜线（*/）作为结尾，中间部分全部都是文档注释，会被提取到API文档中。

自行搜索一下javadoc即可，示例如下：

/**
 * 类描述
 *
 * @author 作者
 * @version 版本
 */
public class DemoClass {
	/**
	 * 内部属性：name
	 */
	private String name;	
	
	/**
	 * Setter方法
	 * @return name
	 */
	public String getName() {
		return name;
	}

	/**
	 * Getter方法
	 * @param name
	 */
	public void setName(String name) {
		this.name = name;
	}

}

Answer 2

你可以试着用JAVADOC命令，很方便的。
注释
@author 作者名
@version 版本标识
@parameter 参数及其意义
@since 最早使用该方法/类/接口的JDK版本
@return 返回值
@throws 异常类及抛出条件
@deprecated 引起不推荐使用的警告
@see reference
@override 重写

命令
javadoc [选项] [软件包名称] [源文件] [@file]

具体的可以去百度上搜一下，百度百科上有。

Answer 3

chm文件编辑器 你要的是这个东西吧