java api接口文档怎么编写？

Python010

java api接口文档怎么编写？,第1张

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

api是应用程序接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问原码，或理解内部工作机制的细节。api接口属于一种操作系统或程序接口，GUI接口属于一种图形操作系统，两者都属于直接用户接口。有时公司会将api作为其公共开放系统。也就是说，公司制定自己的系统接口ᨌ/p>