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
一个所见即所得的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帮助文档的更多相关文章
- 如何使用eclipse生成javadoc帮助文档
---恢复内容开始--- 如果你已经能制造轮子了,你想让其他人使用你的轮子,那你就得告诉他们你的轮子都是由什么构成的.这样他们才能更好的使用你制造的轮子.然而,很多开发者都不想写长篇大论的帮助文档,这 ...
- 用idea生成javadoc在线文档
1.点击需要生成文档的包 2.点击tools--->选择generate javaDoc /1选择输出目录 /2防止中文乱码建议加上: -encoding utf-8 -charset utf- ...
- javadoc 工具生成开发API文档
=====================先来一点成就感===================== package com.springMybatis.dao; import com.springMy ...
- javadoc 自动生成java帮助文档
用法: javadoc [options] [packagenames] [sourcefiles] 选项: -public 仅显示 public 类和成员 -protected 显示 protect ...
- 如何生成一个java文档
如何生成一个java文档 众所周知,一个程序给别人看可能可以看懂,几万行程序就不一定了.在更多的时候,我们并不需要让别人知道我们的程序是怎么写的,只需要告诉他们怎么用的.那么,api文档就发挥了它的作 ...
- 使用 Sandcastle 生成代码帮助文档
使用 Sandcastle可以生成MSDN风格的帮助文档,生成的帮助文档既可以是chm文档,也可以是MS Help 2.x帮助文档. 1 下载并安装Sandcastle Sandcastle下载地址为 ...
- 【20140113-2】MyEclipse生成javadoc时出错:编码GBK的不可映射字符
今天生成java doc文档时,出现了如下所示的错误: 正在装入软件包 com.wisdom.test 的源文件...F:\workspace\StringUtils\src\com\wisdom\t ...
- Swagger+Spring mvc生成Restful接口文档
简介 Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法,参数和模型紧密集 ...
- GhostDoc:生成.NET API文档的工具 (帮忙文档)
在 Sandcastle:生成.NET API文档的工具 (帮忙文档) 后提供另一个生成API文档的工具. 1) 准备工作 安装GhostDoc Proc. 收费的哦.... 这个工具的优势是不像 ...
随机推荐
- js练习 原型
//var a = { // fun: function a() { // test = 0; // alert(this) ...
- out.println(session.getLastAccessedTime());的返回值到底是毛线意思???
out.println(session.getLastAccessedTime());这个语句是输出最后一次成功获取session对象Attribute值的一个指令, 他的返回值是一个long型数据, ...
- 中国大陆被SCI收录的较高影响力期刊
1.清华主办的期刊Nano Research 清华新闻网2012年9月10日电:据汤森路透公司公布的2011年SCI期刊影响因子,清华大学主办的期刊Nano Research(纳米研究)的影响因子为6 ...
- Socket调用方式(同步,异步,阻塞,非阻塞)
同步: 我调用一个功能,该功能没有结束前,我死等结果. 异步: 当一个异步过程调用发出后,调用者不能立刻得到结果.该功能在完成后,通过状态.通知和回调来通知调用者. 同步和非同步关注的是调用者是否等待 ...
- 为什么都说UX / UI设计师是最佳工作?
以下内容由Mockplus团队翻译整理,仅供学习交流,Mockplus是更快更简单的原型设计工具. 你将成为永远热爱自己工作的人,做着自己喜欢的工作还能得到相应的成果和报酬,就好似在度带薪年假一般,何 ...
- linux 关键发行版及其关系图
- 如何用Python实现常见机器学习算法-3
三.BP神经网络 1.神经网络模型 首先介绍三层神经网络,如下图 输入层(input layer)有三个units(为补上的bias,通常设为1) 表示第j层的第i个激励,也称为单元unit 为第j层 ...
- 441. Arranging Coins
static int wing=[]() { std::ios::sync_with_stdio(false); cin.tie(NULL); ; }(); class Solution { publ ...
- HTML5 桌面消息提醒
Notification HTML5新属性,复制代码创建HTML文件,浏览器查看效果 <!DOCTYPE html> <html lang="en"> &l ...
- IO多路复用原理
(1)IO multiplexing(2)用在什么地方?多路非阻塞式IO.(3)select和poll(4)外部阻塞式,内部非阻塞式自动轮询多路阻塞式IO IO多路复用原理:其实就是整个函数对外表现为 ...