生成自己项目的API文档

原创 2018年04月16日 11:00:34

    JDK中的常用包:

      java.lang-包含一些Java语言的核心类,如StringMathIntegerSystemThread,提供常用功能。

      java.net-包含执行与网络相关的操作的类。

      java.io-包含能提供多种输入/输出功能的类。

      java.util-包含一些实用工具类,如定义系统特性、使用与日期日历相关的函数。

生成自己项目的API文档:

   •    特殊的注释:

–    文档注释:/**

1.    右键单击项目,选中export

–    使用JAVADOC生成API文档

–    解决问题:代码和文档的分离

    •    常用的java注释标签:

–    @Author 作者

–    @version 版本

–    @param  参数

–    @return  返回值的含义

–    @throws 抛出异常描述

–    @deprecated 废弃。建议用户不在使用该方法

在eclipse中创建API文档的步骤:

 右键单击项目,选中export


洪峰:泛系、自由与“一、百、万”工程(二)

 (八)结识斯托曼博士(1)焦点时刻1999年10月,吴教授受香港大学的邀请去讲学,需要将护照和入港通行证让我从北京捎回武汉。在此之前,我组织人力和物力翻译了奥莱理出版的《开源软件文集》一书,正如书名...
  • bruce
  • bruce
  • 2003-09-12 19:24:00
  • 2759

11.如何生成自己项目的API文档

    •    特殊的注释:–    文档注释:/**–    使用JAVADOC生成API文档–    解决问题:代码和文档的分离    •    常用的java注释标签:–    @Author...
  • qq_41599832
  • qq_41599832
  • 2018-02-18 03:37:11
  • 24

如何将一个项目导出成API文档

第一步:在项目中,所有的注释 应该是javadoc 模式的,导出时候才会出现/** * 测试 说明 * * @author admin */第二步:选择导出javadoc模式 -...
  • u010735684
  • u010735684
  • 2016-06-21 13:12:43
  • 735

给自己的java程序生成API帮助文档

课本上提到“要学会给自己编写的程序生成API帮助文档”,但又没有说明具体的操作步骤。...
  • ke_shui_zhu
  • ke_shui_zhu
  • 2016-04-16 14:50:05
  • 1648

如何生成自己项目的API文档

文档注释:/**然后点回车出来 项目-右键-EXPORT-JAVA-Javadoc
  • qq_24665261
  • qq_24665261
  • 2015-04-18 17:27:35
  • 100

api文档、packpage的概念、生成自己项目的api文档

API是什么? Application Programming Interface 应用程序编程接口 packpage的简单使用 java中的核心包:java.lang包 为什么需要packp...
  • qq_39588027
  • qq_39588027
  • 2018-04-18 14:30:27
  • 8

Cocos2d-x 之 自己生成API文档

用Doxygen生成cocos2d-x的API文档
  • lx417147512
  • lx417147512
  • 2015-12-13 00:04:24
  • 940

26_api文档_package的概念_生成自己项目的api文档

1.API API是什么? API:Application Programming Interface,应用程序编程接口。 2.package为什么需要package? 为了便于管理类:合适...
  • qq_21122243
  • qq_21122243
  • 2017-06-05 15:07:23
  • 113

如何在eclipse中,为整个工程生成javadoc文档

使用eclipse生成文档(javadoc)主要有三种方法: 1、在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步。 在Ja...
  • shy_snow
  • shy_snow
  • 2010-07-22 15:17:00
  • 8294

springmvc集成Swagger自动生成api文档

springmvc集成Swagger自动生成api文档准备工作下载swaggerUI: https://github.com/swagger-api/swagger-ui maven项目中,添加pom...
  • duanjiajia
  • duanjiajia
  • 2017-01-11 10:56:37
  • 2159
收藏助手
不良信息举报
您举报文章:生成自己项目的API文档
举报原因:
原因补充:

(最多只允许输入30个字)