IDEA写API文档的两种方法

包机制

包的本质就是文件夹

一般利用公司域名作为包名 com.baidu.www com.hestudy.www

导入包 import com.hestudy.Demo1;

导入包下所有的类：import com.hesudy.base.*;

JavaDoc

搜索JDK 帮助文档

javadoc命令是用来生成自己API文档的

①查找使用IDEA生成Javadoc文档

首先新建一个文件夹，用于存放要生成的Javadoc文档。
接下来点击IntelliJ IDEA顶部的Tools菜单，选择Generate JavaDoc选项
然后在弹出的界面中我们点击Output directory输入框后面的按钮
在弹出的选择文件夹界面中选择刚才新建的文件夹
接下来在底部的Locale输入框配置语言和编码集，语言用zh_CN，代表中文，

编码集用 -encoding utf-8 -charset utf-8
然后点击确定以后我们就等待IntelliJ IDEA给我们生成JavaDoc文档即可，等到输出栏出现如下图所示的提示代表生成完毕
接下来我们打开JavaDoc文件夹，找到index.html文件,点击就能看到API文档。

②命令行生成文档

首先找到类的Show in Explorer
在上方文件夹地址输入cmd加空格，enter进入
在doc命令行输入javadoc -encoding UTF-8 -charset UTF-8 Doc.java
接下来我们打开文件夹，找到index.html文件,点击就能看到API文档

参数信息

@author：作者名
@version：版本号
@since：指明需要最早使用的jdk版本
@param:参数名
return：返回值情况
throws：异常抛出情况

/*** @author  hetingting* @version 1.0* @since 1.8*/public class Doc {String name;/*** @author hetingting* @param name* @return* @throws Exception*/public String test(String name) throws Exception{return  name;}

IDEA写API文档的两种方法相关推荐

生成Doc文档的两种方法
生成Doc文档的两种方法一.通过在cmd的执行 javadoc命令通过以下图片打开Java文件所在路径在打开的目录文件的路径前面加上cmd 进入DOS命令在命令行中执行javadoc -enc ...
第十二节：WebApi自动生成在线Api文档的两种方式
一. WebApi自带生成api文档 1. 说明通过观察,发现WebApi项目中Area文件夹下有一个HelpPage文件夹,如下图,该文件夹就是WebApi自带的生成Api的方式,如果该文件夹没了 ...
Java调用打印机打印PDF文档的两种方法
最近,由于项目需求,需要增加系统调用打印机打印PDF文档功能.以前在Asp.Net项目中做过套打,但是现在的需求直接文档打印,下面是实现代码调用打印机的两种方法. 1.Java Print Servi ...
先写API文档还是先写代码？你需要这款神器Apifox！
代码未动,文档先行其实大家都知道 API 文档先行的重要性,但是在实践过程中往往会遇到很多困难. 程序员最讨厌的两件事:1. 写文档,2. 别人不写文档.大多数开发人员不愿意写 API 文档的原因是 ...
还在发愁写API文档？推荐一款阿里腾讯都在用的API管理神器！
欢迎关注方志朋的博客,回复"666"获面试宝典前言 ❝ 程序员最讨厌的两件事:1. 写文档,2. 别人不写文档.大多数开发人员不愿意写 API 文档的原因:写文档短期收益远低于付 ...
Ｗord 2003中打开最近操作过的文档的两种推荐的方法
本文介绍Word 2003中打开最近操作过的文档的两种推荐的方法. 注:我的系统为WINDOWS 7,与XP下基本一致. 方法1: 在WINDOWS 7下,点击任务栏上的WINDOWS图标(即&quo ...
Javadoc转换chm帮助文档的四种方法总结
使用jd2chm.exe方式无法完成,不晓得为什么. 所以用的javadoc2chm 方式,但是chm文档开头AllClass乱码, 用chmeditor修改就可以了点击Files 下的工具类文档. ...
PPT转成Word文档的四种方法
注: 实际使用中,方法四比较好使. 如果想要提取图片,可以先转换成pdf,再转换成word. 方法一:利用"大纲"视图打开PPT演示文稿,单击"大纲&quo ...
php自写api文档生成工具
框架改版后的第二个版本定下来了,这两天也比较轻松,于是就折腾给项目建个好看的api文档. 各种折腾.先是折腾phpDocumentor2,用phpdoc开源工具来建立文档,好不容易安装成功,各个模板都 ...

IDEA写API文档的两种方法

包机制

JavaDoc

IDEA写API文档的两种方法相关推荐

最新文章

热门文章