java api接口文档怎么编写？

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

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

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

1234567891011121314151617181920212223242526272829/** * 类描述 * * @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   } }

随便CTRL+鼠标左键点击Java自身的某一个类,比如String

会进入如下界面,点击attach sources 按钮

d出框口庆弯中选择External location。在JDK的根枯掘目录下有一个名没差核为src.zip的压缩包,path一项就填入这个压缩包的路径。

至此结束

import java.io.BufferedWriter

import java.io.File

import java.io.FileWriter

import java.io.IOException

import java.util.Scanner

public class OutToTxt {

private static BufferedWriter writer

private static Scanner sc

public static void main(String[] args) {

File out = new File("./Out.txt")

if(!out.exists()) {

try {

out.createNewFile()

} catch (IOException e) {

e.printStackTrace()

}

}

try {

writer = new BufferedWriter(new FileWriter(out))

} catch (IOException e) {

e.printStackTrace()

}

sc = new 卖岩皮Scanner(System.in)

System.out.println("请输入文中差本内容，输入exit结束：")

try {

writer.write("") // 清空文本

String split = "枣余"

while(true) {

String line = sc.nextLine()

if(line.equalsIgnoreCase("exit")) {

break

}

writer.append(split + line)

split = "\r\n"

}

} catch (IOException e1) {

e1.printStackTrace()

} finally {

if(null != writer) {

try {

writer.flush()

writer.close()

} catch (IOException e) {

e.printStackTrace()

}

}

}

}

}

你可以运行后输入

Hello World!

This is my first application.

exit

---