育才学习网1.java api 接口怎么编写
Java语言提供了一种强大的注释形式：文档注释。可以将源代码里的文档注释提取成一份系统的API文档。我们在开发中定义类、方法时可以先添加文档注释，然后使用javadoc工具来生成自己的API文档。
文档注释以斜线后紧跟两个星号（/**）开始，以星号后紧跟一个斜线（*/）作为结尾，中间部分全部都是文档注释，会被提取到API文档中。
自行搜索一下javadoc即可，示例如下：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
/**
* 类描述
*
* @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;
}
}
2.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; }}。
3.软件接口说明文档怎么写
1 引言
1.1编写目的
说明编写这份详细设计说明书的目的，指出预期的读者。
1.2背景
说明：
a.待开发软件系统的名称；
b.本项目的任务提出者、开发者、用户和运行该程序系统的计算中心。
1.3定义
列出本文件中用到专门术语的定义和外文首字母组词的原词组。
1.4参考资料
列出有关的参考资料，如：
a.本项目的经核准的计划任务书或合同、上级机关的批文；
b.属于本项目的其他已发表的文件；
c.本文件中各处引用到的文件资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。
2 程序系统的结构
用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间 的层次结构关系。
3 程序1（标识符）设计说明
从本章开始，逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。 对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层 模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。
3.1程序描述
给出对该程序的简要描述，主要说明安排设计本程序的目的意义，并且，还要说明本程序的特点（如 是常驻内存还是非常驻？是否子程序？是可重人的还是不可重人的？有无覆盖要求？是顺序处理还是并发 处理卜…..等）。
3.2功能
说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图）的形式。
3.3性能
说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。
3.4输人项
给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。 数量和频度、输入媒体、输入数据的来源和安全保密条件等等。
3. 5输出项
给出对每一个输出项的特性，包括名称、标识、数据的类型和格式，数据值的有效范围，输出的形式、数量和频度，输出媒体、对输出图形及符号的说明、安全保密条件等等。
3.6算法
详细说明本程序所选用的算法，具体的计算公式和计算步骤。
3.7流程逻辑
用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的逻辑流程。
3.8接口
用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数赋值和调用方式，说明与本程序相直接关联的数据结构（数据库、数据文卷）。
3.9存储分配
根据需要，说明本程序的存储分配。
3.10注释设计
说明准备在本程序中安排的注释，如：
a. 加在模块首部的注释；
b.加在各分枝点处的注释； 对各变量的功能、范围、缺省条件等所加的注释；
d.对使用的逻辑所加的注释等等。
3.11限制条件
说明本程序运行中所受到的限制条件。
3.12测试计划
说明对本程序进行单体测试的计划，包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定。
3.13尚未解决的问题
说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。
4 程序2（标识符）设计说明
用类似3的方式，说明第2个程序乃至第N个程序的设计考虑。
4.软件接口说明文档怎么写
1 引言 1.1编写目的说明编写这份详细设计说明书的目的，指出预期的读者。
1.2背景 说明： a.待开发软件系统的名称； b.本项目的任务提出者、开发者、用户和运行该程序系统的计算中心。 1.3定义 列出本文件中用到专门术语的定义和外文首字母组词的原词组。
1.4参考资料 列出有关的参考资料，如： a.本项目的经核准的计划任务书或合同、上级机关的批文； b.属于本项目的其他已发表的文件； c.本文件中各处引用到的文件资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。
2 程序系统的结构用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间 的层次结构关系。3 程序1（标识符）设计说明 从本章开始，逐个地给出各个层次中的每个程序的设计考虑。
以下给出的提纲是针对一般情况的。 对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层 模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。
3.1程序描述 给出对该程序的简要描述，主要说明安排设计本程序的目的意义，并且，还要说明本程序的特点（如 是常驻内存还是非常驻？是否子程序？是可重人的还是不可重人的？有无覆盖要求？是顺序处理还是并发 处理卜…..等）。3.2功能 说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图）的形式。
3.3性能说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。3.4输人项 给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。
数量和频度、输入媒体、输入数据的来源和安全保密条件等等。3. 5输出项 给出对每一个输出项的特性，包括名称、标识、数据的类型和格式，数据值的有效范围，输出的形式、数量和频度，输出媒体、对输出图形及符号的说明、安全保密条件等等。
3.6算法 详细说明本程序所选用的算法，具体的计算公式和计算步骤。3.7流程逻辑 用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的逻辑流程。
3.8接口用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数赋值和调用方式，说明与本程序相直接关联的数据结构（数据库、数据文卷）。 3.9存储分配 根据需要，说明本程序的存储分配。
3.10注释设计 说明准备在本程序中安排的注释，如： a. 加在模块首部的注释； b.加在各分枝点处的注释； 对各变量的功能、范围、缺省条件等所加的注释； d.对使用的逻辑所加的注释等等。 3.11限制条件 说明本程序运行中所受到的限制条件。
3.12测试计划 说明对本程序进行单体测试的计划，包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定。 3.13尚未解决的问题说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。
4 程序2（标识符）设计说明用类似3的方式，说明第2个程序乃至第N个程序的设计考虑。
5.java怎么使用API帮助文档
API就像学汉字时候的汉语字典一样，编程的时候需要用到的基本类都在API里面存在了，并且随着时间的推移，这些类的数量会越来越多。
一般打开API，你可以看到三部分，左上，左下和右边。左上部分是所有的包，它是最大的部分；然后左下部分是你所选的左上部分的包里面的具体内容，一般有接口、类、枚举、异常、错误等等。当你选择左下部分的具体类的时候，在右部分就会出现这个类的具体解释，然后是它的构造方法，常用方法等。我们主要关注的是常用方法。
看API的时候，比如你要找String类，那么你首先需要知道它在类的什么位置，也就是在哪个包里面，然后你通过连接找到String类（在java.lang包里面），然后在java.lang包里面找到String类，接着就可以查看String类的具体内容了。比如在解释String的时候，就说了String对象是不可改变的，（这听起来似乎比其他的废话重要一点），然后是对String类的方法做了一个大概的介绍。接着，就可以看具体的方法了。
比如说，你要比较一个字符串，那么就需要用到equals(Object anObject)方法，它的参数是一个对象，方法解释是：将此字符串与指定的对象比较。
具体用法，比如String str = "a"; str.equals("b");
因为“a"不等于"b"，所以，这个方法返回的是false。
6.java中的API是什么
API=Java Application Interface。 就是指那套基本类库。
没有那套库，没有这套编程接口，你编写应用程序将不是一般地困难。
作为Sun开发的Java程序，用于Java编程人员使用的程序接口，并不是说使用Java和接口有关，而是表示Java所提供的现成的类库，供编程人员使用。这与 Win32 中的 dll 文件有点像，封装了好多函数，只暴露也函数名、参数等信息，不提供具体实体，暴露出来的这些就称为API了。也就是说 Java 也是封装了好多的方法，提供了些方法名和参数等信息，便于别人使用啊。由于Java是开源的，还可是看到类库中方法的具体实现。
*这个文档是让你查看那些你要或者将要使用的类的定义，属性，方法集，还有相关参数的说明，以及一些例子，
也就是说如果你忘记或不知道某个类的用法，可以查这个参考书，但是如果程序出错，如果不是类使用错误，这个文档基本上帮不上忙的。
如果程序出错是类使用的错误，信息应该会指示哪行出错，你可以查看这行使用的类的方法或属性和jdk documentation文档描述是否一致。
转载请注明出处育才学习网 » javaapi接口说明文档怎么写