为项目生成html/chm格式API

准备工作:

Javadoc to chm官网: http://jan.baresovi.cz/dr/en/javadoc-chm  -> 下载javadoc2chm.1.3.1.11.msi

HTML Help Workshop: http://www.microsoft.com/en-us/download/details.aspx?id=21138 -> 下载htmlhelp.exe


一. 将项目导出成html格式API文档

1. 选中项目 -> 菜单栏Project -> Generate Javadoc...

2. 选择visibility, 默认是Public, 可以选择Private; 点击Browse...选择输出路径 -> Next

3. 为API文档起个名字, 例如: Project Doc; 为了保证生成的api过程中没有错误, 点击Select All选择所有的引用jar包(注意:如果有些jar包不在列表中, 如servlet-api.jar, 可以将这个jar包复制到项目的lib目录下, 等生成完api文档后, 再从项目的lib目录下删除掉) -> Next


4. 为保证生成过程中, 编码不统一导致错误, 这里加上一行参数: -encoding utf-8 -charset utf-8


5. Finish -> Yes To All; 如果控制台有错误, 将错误解决掉, 警告可以忽略掉, 之后就可以到指定的路径下查看生成的api文档了


二. 将html格式API转为chm格式

1. 安装之前下载的javadoc2chm.1.3.1.11.msi 及 htmlhelp.exe

2. 安装完成后, 在开始 -> 所有程序 -> javadoc2chm -> 点击打开”javadoc2chm”

3. 点击Browse…选择index.html文件, 填写输出文件名称, 以及生成的chm文件的title


4. 点击Go按钮, 开始生成chm文件, 完成后, 进入Progress会显示Finished


5. 查看生成的文档

  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
当你想把网页制作成某种模样时,需要使用一种编码向网络浏览器来进行解释,这种编码就被称为HTML代码。   一个HTML文件是一页文字信息,就象一封电子邮件或一个word字处理文档,而且实际上你完全可以使用Word字处理软件来编写一个HTML网页。你也可以通过其它字处理软件编写文本文件,网络浏览器只能处理文本信息。   一个HTML文件中包含了所有将显示在网页上的文字信息,其中也包括对浏览器的一些指示,如哪些文字应放置在何处,显示模式是什么样的等。如果你还有一些图片、动画、声音或是任何其它形式的资源,HTML文件也会告诉浏览器到哪里去查找这些资源,以及这些资源将放置在网页的什么位置。HTML文件通过标志符(tag)来实现这一功能。   标志符是一些字母或单词,并被放在尖括号内,例如。HTML文件可支持很多种标志符,而我们常讲的学习HTML语言实际上就是学习这些各种各样的标志符。   每种标志符的作用均不同,例如,如果有的控制将文字放大,有的控制将文字居中显示,有的则负责与其它信息进行链接。当你需要对某处进行修改时,就把标志符放置在该处前面,这时浏览器就会知道你希望下面的内容应如何显示了。   例如,你想把“订书机”这三个字用粗体显示,从而在网页中突出这三个字,因为既然你的网页是关于订书机的知识,自然订书机是网页中最重要的词汇。这时你就需要告诉浏览器你想将“订书机”三个字用粗体显示,方法是使用粗体标志符:    <b>   "B"是英文"bold"的首字母,意即“粗体”,实际上很多标志符都是使用的英文缩写,这也能够方便使用者记住它们。当你使用<b>这个标志符后,就会告诉浏览器说:“我希望在此之后的所有内容均以粗体显示。”而浏览器自然会按照你的指令将这个标志符后所有的内容均以粗体显示。   当你使用了标志符时会出现一个问题,即在此之后的所有内容都会根据此标志符的要求改变显示模式,也就是说浏览器不知道何时何处停止这种变化,而实际上你可能只是希望一页中某个部分的内容改变显示。为了防止这种情况的发生,你就需要告诉浏览器在何处终止这种变化,这时你就可以使用结尾标志符。结尾标志符和普通的标志符(有时称为起始标志符)非常相似,只是在字母之前有一个斜线,例如粗体显示的结尾标志符就是下面这个样子:    </b>   这个结尾标志符的作用就是告诉浏览器在此之后就不要再用粗体显示了。因此如果你希望将“订书机”这三个字用粗体显示,就应该将一个粗体起始标志符放置在“订书机”三个字前面,而将一个粗体结尾标志符放置在这三个字后面:   这个结尾标志符的作用就是告诉浏览器在此之后就不要再用粗体显示了。因此如果你希望将“订书机”这三个字用粗体显示,就应该将一个粗体起始标志符放置在“订书机”三个字前面,而将一个粗体结尾标志符放置在这三个字后面:   <b>staplers</b>   你可以把标志符放置在网页中的任意部位,浏览器不会把这些标志符也显示出来,而只是读取它们的信息,并按照标志符的要求对其下面的内容进行特殊显示。例如你写好了一篇关于订书机的文章,希望使一些文字用粗体显示,那么你可以这样做: 世界上没有比 我漂亮的<b>订书机</b> 更让我喜爱的东西了 我从杂货店买到了它 但任何优美的语言 都无法描述<b>订书机</b>的优点    当网络浏览器看到上面这段编码后,就会以下面的样式显示这段文字: 世界上没有比 我漂亮的订书机 更让我喜爱的东西了 我从杂货店买到了它 但任何优美的语言 都无法描述订书机的优点    这就是一段HTML代码,而如果你能够理解本节所讲的起始标志符和结尾标志符的含义,那么你就能够学会其它一些标志符所代表的意义。也许读过本文后,你就能够成为一名网页设计师了。   好了,下面让我们把前面介绍的一些知识投入到正式的工作应用中。你在编写一个HTML文件时需要使用一个文字编辑器,如果你使用的是Macintosh系统,你的文字编辑器可能叫做SimpleText,这个软件完全能够满足我们当前的要求。而如果你使用的是windows系统,你的文字编辑器应该叫做Notepad。请将任何一种文字编辑器打开,并建立一个新的空白文件,然后向其中输入一些HTML代码。    所有的HTML文件都必须以相同的标志符起始和结束,例如当你使用<b>标志符来告诉浏览器将后面的内容以粗体显示之前,你还需要使用一些标志符来告诉浏览器它下面即将读取的是一份HTML文件,因此一般情况下HTML网页的第一个标志符应该是<html>,而与之对应,在该页的结尾处,你应该用</html>做为全文的结束。    <html>标志符内是<body>标志符,标志符是告诉浏览器这里面的内容是网页的实际内容。对于一个最简单的网页来说,<html>和<body> 这两个标志符是你唯一必须使用的标志符。虽然你可以使用更多的标志符使你的网页功能更丰富,但在目前我们完全可以只利用这两个标志符。也就是说,只要你在<body>标志符内输入一些文字信息,你就制作出了一个最简单的网页。   请将下列内容输入至你的文本编辑器中(如SimpleText, Notepad,或任何一种编辑器): <html> <body>    这是我制作的关于订书机的网页,我觉得我的网页很不错,我想我已经是一位HTML主页制作大师了,所有人都应该崇拜我! </html> </body>    好了,保存这页文件,给它随便起一个名字,但别忘了在文件名后一定要加上.html这个扩展名,这样网络浏览器才能够识别出这个文件,正确读取它。在这里我们把该页命名为“订书机.html”。    这样你就制作出了自己第一个网页,你现在应该感到很高兴吧。虽然你现在只学习了网页制作非常少的知识,但至少你已经能够制作网页了。那么接下来让我们看一看你制作的网页到底是什么样子。   打开你的浏览器(如Netscape Navigator, Internet Explorer或任何其它的浏览器),从中打开你编辑的网页文件,方法是打开"File"(文件)菜单,根据不同的浏览器请选择"Open Page"(打开网页)或"Open File"(打开文件),寻找到你的“订书机.html”文件并选中,这样浏览器就会打开这个文件了。文件打开后,该页应该在左上角有几行文字,其余是一片空白。    如果不是这样的话,那么你可能忘记输入某个标志符或丢掉了斜线或是尖括号或是其它什么重要信息。这种情况经常会发生,即使那些网页制作大师们有时也会犯一些简单的错误,因为忘掉一个符号太容易发生了。当你发现自己的网页存在问题时,下面就需要进行修改。    浏览器自己可不知道在哪添加个标志符使网页正确显示出来。如果你希望象我们前面讲到的把“订书机”这三个字变为粗体,就需要返回文本编辑器中添加<b>标志符并重新保存该文件。这时你在浏览器中点击刷新按钮后就会显示出正确的文字了。这个刷新的操作告诉浏览器重新寻找同一个文件(本例中即“订书机.html”文件)并重新显示,这时你就会发现“订书机”三个字已经用粗体显示了。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值