MyEclipse生成Javadoc帮助文档

转载自 MyEclipse生成Javadoc帮助文档

Javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形式程序的开发文档了。

Javadoc输出的是一些静态网页文档，经过WEB浏览器来查看它。
Javadoc的语言规则：
所有Javadoc都只能源于结束。应用javadoc有二种方法：

一种是嵌入静态网页；

Javadoc将静态网页源代码嵌入到所生成的静态网页文档中。那样能充分利用静态网页的功能。比如：

另一种是应用文档标签

Sample：

import java.util.*;   public class JavaDocTest {   public static void main(String[] args){   System.out.print("HelloWorld!");
}
}

Javadoc只能为public或者protected成员停止文档注释。private和包内访问的成员的注释会被忽略掉。那样做是有道理的，由于只有public和protected成员才能在文档之外被应用，这也体现了封装性的优点。

一、利用Myeclipse都可轻松制作javadoc

利用Myeclipse生产javadoc文档的步骤如下：

1.选择File->Export->javadoc，下一步。

2.Javadoc comand选择JDK的bin目录下的javadoc.exe。选择要生成的源代码和javadoc保存的目的路径，下一步。

3.Document title输入标题，下一步。

4.Extra Javadoc options输入

-windowtitle 'Type B Monitor'[浏览器显示标题]

-bottom <center>Travelsky</center>[底部显示文本]，

如果出现编码错误，则填写以下这句

比如项目采用的是UTF－8的编码就填：

-encoding UTF-8 -charset UTF-8

二、利用3个插件都可轻松制作javadoc

JDocEditor,JAutoDoc,Java2Html。三个小工具，轻松制作JavaDoc.一个是可见即所得的JavaDoc编辑工具，一个是自动建立代码注释的工具，一个是把代码转换成Html格式的工具。
JDocEditor:
http://www.certiv.net/download/downloads.html#jdoceditor
一个所见即所得的Java Doc 编辑器。不用再费神地在代码中调整注释的html标记了，可以自由地编出高质量的带丰富格式的Java Doc 。

JAutoDoc
http://jautodoc.sourceforge.net/index.html#download
自动建立Java Doc 文档。功能十分强大，三个命令实现在所有源代码中加入完整的Java Doc注释。一个命令是加入Package的说明文档，在Package中加入package.html，对package进行说明。
第二个命令是代码文件的头部注释。一个命令就可以自动地在项目的所有代码文件中加入头部注释，或者替换原来的注释。
第三个命令为类、方法、属性加入注释说明。可以根据模式匹配，自动地根据方法的名称，建立更为具有可读性的注释文本。

Java2Html
http://www.java2html.de/eclipse.html
准确地说它不是用来直接建立JavaDoc 的，但是可以用来建立其他文档。它的功能是，把Eclipse中的语法色彩格式转换成为Html,让粘贴到网页上，或者其他文档中的代码带有清晰的语法格式。

MyEclipse生成Javadoc帮助文档相关推荐

android内存溢出错误,Android Studio 生成 JavaDoc 空指针异常|文档编码出错|内存溢出...
一般使用Android Studio生成 JavaDoc会有三个问题: 1.空指针异常 Tools --> Generate JavaDoc -->打开对话框活,在"Other ...
Javadoc（文档注释）详解
Java 支持 3 种注释,分别是单行注释.多行注释和文档注释.文档注释以/**开头,并以*/结束,可以通过 Javadoc 生成 API 帮助文档,Java 帮助文档主要用来说明类.成员变量和方法的 ...
swagger 扫描java文档_推荐一款在运行时通过javadoc生成Swagger API文档的库
介绍一般,我们使用Springfox生成swagger api文档,但Springfox不支持从javadoc中生成,只能通过注解的方式标注文档. 这样,当共享一些POJO类时,为了同时生成java ...
JavaDoc命令生成JDK帮助文档
java中文档注释字段 @author 作者@version 版本号@since 这个java类最早支持到哪个版本使用@param 入参@return 返回值@throws 抛出异常//可以通过jav ...
Java注释详解-Java文档注释生成Java API文档
Java文档注释是一种功能强大的注释形式,如果在你所编写的程序中规范的添加文档注释,那你就可以生成一份系统正规的API文档.Java文档注释 /**文档注释内容*/,注意区分多行注释/*多行注释*/. ...
FastAPI 自动生成的docs文档没法使用
FastAPI 自动生成的docs文档没法使用,当展开路径时候一直在转圈,具体就是这样这个是由于swagger-ui 3.30.1 中的bug导致,具体bug可以看这里我们可以通过在FastAPI ...
ASP.NET Web API 使用Swagger生成在线帮助测试文档
ASP.NET Web API 使用Swagger生成在线帮助测试文档 Swagger-UI简单而一目了然.它能够纯碎的基于html+javascript实现,只要稍微整合一下便能成为方便的API在线 ...
开发日记-20190328 关键词利用eolinker一键快速生成API接口文档
今天感觉效率真的很低= =各个层面的,apk发布到现场发现出现了问题,所以一个下午都在忙着解决现场出现的问题,领导一直打电话询问进度,午觉也没有睡所以今天预计的很多计划都处于停滞状态,像昨天规划的今天 ...
Spring Boot 集成 Swagger 生成 RESTful API 文档
原文链接: Spring Boot 集成 Swagger 生成 RESTful API 文档简介 Swagger 官网是这么描述它的:The Best APIs are Built with Swa ...

MyEclipse生成Javadoc帮助文档

MyEclipse生成Javadoc帮助文档相关推荐

最新文章

热门文章