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

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

一种是嵌入静态网页;

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

  1.   

另一种是应用文档标签

Sample:

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

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
一个所见即所得的JavaDoc 编辑器。不用再费神地在代码中调整注释的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帮助文档的更多相关文章

  1. 如何使用eclipse生成javadoc帮助文档

    ---恢复内容开始--- 如果你已经能制造轮子了,你想让其他人使用你的轮子,那你就得告诉他们你的轮子都是由什么构成的.这样他们才能更好的使用你制造的轮子.然而,很多开发者都不想写长篇大论的帮助文档,这 ...

  2. 用idea生成javadoc在线文档

    1.点击需要生成文档的包 2.点击tools--->选择generate javaDoc /1选择输出目录 /2防止中文乱码建议加上: -encoding utf-8 -charset utf- ...

  3. javadoc 工具生成开发API文档

    =====================先来一点成就感===================== package com.springMybatis.dao; import com.springMy ...

  4. javadoc 自动生成java帮助文档

    用法: javadoc [options] [packagenames] [sourcefiles] 选项: -public 仅显示 public 类和成员 -protected 显示 protect ...

  5. 如何生成一个java文档

    如何生成一个java文档 众所周知,一个程序给别人看可能可以看懂,几万行程序就不一定了.在更多的时候,我们并不需要让别人知道我们的程序是怎么写的,只需要告诉他们怎么用的.那么,api文档就发挥了它的作 ...

  6. 使用 Sandcastle 生成代码帮助文档

    使用 Sandcastle可以生成MSDN风格的帮助文档,生成的帮助文档既可以是chm文档,也可以是MS Help 2.x帮助文档. 1 下载并安装Sandcastle Sandcastle下载地址为 ...

  7. 【20140113-2】MyEclipse生成javadoc时出错:编码GBK的不可映射字符

    今天生成java doc文档时,出现了如下所示的错误: 正在装入软件包 com.wisdom.test 的源文件...F:\workspace\StringUtils\src\com\wisdom\t ...

  8. Swagger+Spring mvc生成Restful接口文档

    简介 Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法,参数和模型紧密集 ...

  9. GhostDoc:生成.NET API文档的工具 (帮忙文档)

    在 Sandcastle:生成.NET API文档的工具 (帮忙文档) 后提供另一个生成API文档的工具.   1) 准备工作 安装GhostDoc Proc. 收费的哦.... 这个工具的优势是不像 ...

随机推荐

  1. android 读取json数据(遍历JSONObject和JSONArray)(转)

    public String getJson(){ String jsonString = "{\"FLAG\":\"flag\",\"MES ...

  2. SOCKET, TCP/UDP, HTTP, FTP 浅析

    SOCKET, TCP/UDP, HTTP, FTP (一)TCP/UDP,SOCKET,HTTP,FTP简析   TCP/IP是个协议组,可分为三个层次:网络层.传输层和应用层: 网络层:IP协议. ...

  3. Kafka管理工具介绍

    Kafka内部提供了许多管理脚本,这些脚本都放在$KAFKA_HOME/bin目录下,而这些类的实现都是放在源码的kafka/core/src/main/scala/kafka/tools/路径下. ...

  4. 一些json在js和c++ jsoncpp的操作

    1.对于javascript部分,如果将字符串转为json对象? var aa ={ keyword:"zoumm", requestcount:"5", ne ...

  5. Ckeditor 中粘贴图片

    我们在ckeditor 中有上传图片,但是实际使用中这种手动上传图片方式并不是很方便,而是复制或者截图粘贴图片. 这里我们实现主要是获取对应的粘贴事件. CKEDITOR.instances[&quo ...

  6. Hbase 系列(一)基本概念

    Hbase 系列(一)基本概念 HBase 是 Apache 旗下一个高可靠性.高性能.面向列.可伸缩的分布式存储系统.利用 HBase 技术可在廉价 PC 服务器上搭建起大规模的存储化集群.使用 H ...

  7. 微信小程序 tp5上传图片

    test.wxml页面 <view class="title">请选择要反馈的问题</view> <view> <picker bindc ...

  8. ARKit对安卓的提示 ARKit与Google Tango

    我们知道安卓是Google开发的,那么关于AR谷歌有哪些作为呢?就是开发了Google Tango,尽管Tango还未开源,但是用户可以免费使用,可是一般的安卓手机是无法运行的,它对硬件有要求,这对它 ...

  9. delphi http 403 获取不到服务器返回的错误消息 用浏览器打开url可以返回

    用delphi的idhttp Get一个url如下: http://117.135.237.4:9090/agent/api/treatmentModeUpdate?userName=VDAwMIMQ ...

  10. Android-自定义开关

    效果图: 需要两张图片,一张图片为背景,一张图片为滑动的点 布局去指定一个自定义View对象: view.custom.shangguigucustomview.MyCustomSwitch < ...