Java如何制作API文档

我是在学习java的时候学到的,是在eclipse上制作的,下面就来一步一步的制作。

  1. 先建一个java工程

2.双击工程-->右键src--> new --> Package(建立一个包)

3.在这个包内建立一个类(右键test(包)--> new -->class)

4.然后就写代码,注意用(/** */)写有关方法的注释

如果你想学习Java可以来这个群,首先是一二六,中间是五三四,最后是五一九,里面有大量的学习资料可以下载。

5.准备工作就做完了,我们右键工程(Demo)-->Export...

这里是选择你下载的jdk的安装目录中的bin的javadoc

6.选择输出的文件目录就可以了

7.最后在文件目录中点indec.html就是自己做的API文档了

8.最后就是这样了

我也是刚学会的,大神们可能有更好的方法,这里只是分享一下,大神如果有跟好的方法,可以分享出来哦。

时间: 2024-12-30 21:58:46

Java如何制作API文档的相关文章

javadoc 制作api文档

ado 首先要养成好的编程习惯1.在程序的开头,变量的开头,注释都采用如下格式    /**      *      */ 然后就可以用javadoc进行文档制作1.建立需要制作文档的包列表      新建一个文件packagelist.txt,内容如下:        com.tju.msnrl.guard.controller        com.tju.msnrl.guard.db.util        com.tju.msnrl.guard.db        com.tju.msn

如何制作中文API文档

问题描述 现在大多数API文档制作工具生成的都是英文的,头说要叫制作一个目录就能是中文的,最好每个接口还可以添加示例的.百度了很久都没有找到能制作中文API文档的,所以来求助了.难道我看的那些中文API都是手动翻译的吗?另说一句,要的是能支持C#的. 解决方案 解决方案二:只有英文的,没有中文的,中文的要自己写,不是导出了事解决方案三:就是还是要自己写中文是吧,那有什么能写中文的工具呢?解决方案四:引用1楼starfd的回复: 只有英文的,没有中文的,中文的要自己写,不是导出了事 那有什么写中文

api文档-android sdk源代码中有的.java文件没有对应的.class文件

问题描述 android sdk源代码中有的.java文件没有对应的.class文件 例如WebViewProvider这个类,在platforms/android-19/android.jar中没有相应的.class文件,而在sources/android-19/android/webkit/中是有这一个java文件的. 而且在API文档中只能找到.class文件的帮助文档.应用在运行时如果用到这个类,是如何找到它的呢?

Java核心技术卷I基础知识3.6.8 阅读联机API文档

3.6.8 阅读联机API文档 正如前面所看到的,String类包含许多方法.而且,在标准库中有几千个类,方法数量更加惊人.要想记住所有的类和方法是一件不太不可能的事情.因此,学会使用在线API文档十分重要,从中可以查阅到标准类库中的所有类和方法.API文档是JDK的一部分,它是HTML格式的.让浏览器指向安装JDK的docs/api/index.html子目录,就可以看到如图3-2所示的屏幕.   图3-2 API文档的三个窗格 可以看到,屏幕被分成三个窗框.在左上方的小窗框中显示了可使用的所

仔细触摸Java编程中的“文档”和“包”

编程 什么是包 Java中的包(Package)其实指的就是目录,它是为了更好地管理Java类(Class)和接口(Interface).Java语言的包可以被另一个Java开发包所使用.如果我们要引用某个包中的类,用import关键字来标明即可.比如: import java.util. date=new Date  提示:import java.util.表示java.util中的所有公有类和接口被引入到当前包.这里的匹配符可以调入多个类名. 常用的Java标准包 JDK为我

Java中的XML: 文档模型,第一部分:性能

使用内存中 XML 文档的 Java 开发者可以选择使用标准 DOM 表示或几个 Java 特定模型中的任何一个.该灵活性已经帮助将 Java 建立成 XML 工作的出色平台.但是,由于不同模型数量的增加,已经更加难以确定如何比较模型的功能.性能和易用性. 关于使用"Java 中的 XML"系列中的第一篇文章研究了 Java 中一些领先的 XML 文档模型的特性和性能.它包括一组性能测试的结果.在系列中的第二篇文章将通过比较为实现同样任务所使用的不同模型的样本代码来研究易用性问题. 文

api-java API文档问题请教大神,哪一个是啊

问题描述 java API文档问题请教大神,哪一个是啊 我下了两个API文件夹javafx-8u72-apidocs和jdk-8u72-docs-all第一个60M第二个380M请问这两个有什么不一样啊,我该看哪一个呢? 解决方案 你安装了jdk,就已经在你的安装目录里有api文档了 解决方案二: 安装目录里哪一个是呢? 解决方案三: 第一个应该就可以了吧,第二个是all,全部的吧 解决方案四: 这两个不是同一个东西啊,javafx是另一种技术JavaFX的文档,JavaFX技术主要应用于创建R

利用Java动态生成 PDF 文档

利用Java动态生成 PDF 文档,则需要开源的API.首先我们先想象需求,在企业应用中,客户会提出一些复杂的需求,比如会针对具体的业务,构建比较典型的具备文档性质的内容,一般会导出PDF进行存档.那么目前最佳的解决方案,你可能会想到 iText ,对没错... iText+(Velocity / Freemarker)可以实现.不过据我熟悉,iText本身提供的HTML解析器还是不够强大,许多HTML标签和属性无法识别,更悲催的是简单的CSS它不认识,排版调整样式会让你头大的.不要失望,接下来

Spring Boot中使用Swagger2构建强大的RESTful API文档

由于Spring Boot能够快速开发.便捷部署等特性,相信有很大一部分Spring Boot的用户会用来构建RESTful API.而我们构建RESTful API的目的通常都是由于多终端的原因,这些终端会共用很多底层业务逻辑,因此我们会抽象出这样一层来同时服务于多个移动端或者Web前端. 这样一来,我们的RESTful API就有可能要面对多个开发人员或多个开发团队:IOS开发.Android开发或是Web开发等.为了减少与其他团队平时开发期间的频繁沟通成本,传统做法我们会创建一份RESTf