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   } }

Java接口(英文：Interface)，在JAVA编程语言中是一个抽象类型，是抽象方法的集合，接口通常以interface来声明。一个类通过继承接口的方式，从而来继承接口的抽象方法，以下是java课程培训机构http://www.kmbdqn.cn/为大家搜索整理的Java接口是什么，希望能给大家带来帮助，更多专业知识请及时关注海文IT知识频道!

接口并不源瞎是类，编写接口的方式和类很相似，但是它们属于不同的概念。类描述对象的属性和方法。接口则包含类要实现的方法。

除非实现接口的类是抽象类，否则该类要定义接口中的所有方法。

接口无法被实例化，但是可以被早拍实现。一个实现接口的类，必须实现接口内所描述的所有方法，否则就必须声明为抽象类。另外，在Java中，接口类型可用来声明一个变量，他们可以成为一个空指针，或是被绑定在一个以此接口实现的对象。

接口与类相似点：

一个接口可以有多个方法。

接口文件保存在.java结尾的文件中，文件名使用接口名。

接口的字节码文件保存在.class结尾的文件中。

接口相应的字节码文件必须在与包名称相匹配的目录结构中。

接口与类的区别：

接口不能用于实例化对象。

接口没有构造方法。

接口中所有的方法必须是抽象方法。

接口不能包含成员变雹睁空量，除了static和final变量。

接口不是被类继承了，而是要被类实现。

接口支持多重继承。

举个面积的例子：在java中，定义一个接口，声明计算长方形面积和周长的抽象方法，再用一个类去实现这个接口，再编写一个测试类去使用这个接口。首先，接口必须单独存放，如果我们用eclipse编程的话，它们提示：The public type **** must be defined in its own file，意思是必须要定义在其自己的文件中，所以要为接口文件单独存放起来，举例，我们的接口滑扰要实现获到矩形的长，宽，面积，周长，所以定义以下的接口。public interface calrect {\x0d\x0apublic abstract int calarea()\x0d\x0apublic abstract int calgirth()\x0d\x0apublic abstract int getx()\x0d\x0apublic abstract int gety()\x0d\x0a}注意，定义接口就像定义类一样，接口的访问控制符只能用public，用public定义的接口可以被所有的类和包引用，而缺省的则只能罩纳被同一个包中的其他类和接口引用，这符合JAVA中访问控制符的一般要求，关于接口再引用其他接口则是后话。以上接口文件名为calrect.java.另外需要指出的是接口中不能给方法给出方法体。接下来，需要定义一个类来实现接口，因为不知道JAVA的内置矩形类是什么名，所以为了安全，将该类定义为RRect，这可以认为是一物让没种安全策略。关于implements，可以参考其他资料。该类引用了接口calrect，所以必须对calrect中的方法一一实现。//定义矩形类 应用接口class RRect implements calrect{private int x\x0d\x0aprivate int ypublic RRect (){\x0d\x0a x=3y=4\x0d\x0a}\x0d\x0apublic int calarea(){\x0d\x0a return x*y\x0d\x0a}\x0d\x0apublic int calgirth(){\x0d\x0a return x*2+y*2\x0d\x0a}\x0d\x0apublic int getx(){\x0d\x0a return x\x0d\x0a}\x0d\x0apublic int gety(){\x0d\x0a return y\x0d\x0a}\x0d\x0a}//接下来，定义一个测试类，所谓测试类，我理解为定义一个类，在其定义类RRect的对象，并验证其中的方法，看看是不是可以正常使用//定义Class1类\x0d\x0apublic class Class1{\x0d\x0aRRect rect\x0d\x0apublic static void main(String []args){\x0d\x0a RRect rect=new RRect()\x0d\x0a System.out.println("矩阵的长"+ rect.getx())\x0d\x0a System.out.println("矩阵的宽"+ rect.calarea())\x0d\x0a System.out.println("矩阵的面积"+ rect.calarea())\x0d\x0a System.out.println("矩形的周长 "+rect.calgirth())\x0d\x0a}\x0d\x0a\x0d\x0a}运行结果：矩阵的长3\x0d\x0a矩阵的宽12\x0d\x0a矩阵的面积12\x0d\x0a矩形的周长 14注：接口单存放，接口实现类和测试类可以存放在一个文件中

---