如何使用javadoc命令生成api文档，文档注释 java api接口文档编写

如何使用javadoc命令生成api文档，文档注释

步骤如下：
第一步：
在工程目录的 src下创建 文件：package.txt .
我的路径是这样的：F:watermusicMyProjectzwhyMyUtilsrc ，即：在src 下创建，package.txt 。
第二步：
打开doc命令窗口，切换到 F:watermusicMyProjectzwhyMyUtilsrc 这个路径下。
输入命令：javadoc -d api @package.txt
回车，这样就可以，生成api 帮助文档了。

java api接口文档编写

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
}

}

如何使用 Grape-Swagger 生成 API 文档

Web API文档工具列表 Swagger ——Swagger框架可以通过代码生成漂亮的在线API，甚至可以提供运行示例。支持Scala、Java、Javascript、Ruby、PHP甚至 Actionscript 3。在线 Demo 。 I/O Docs ——I/O Docs是一个用于RESTful Web APIs的交互式文档系统...