javadoc

使用eclipse生成文档(javadoc)主要有三种方法: 

1,在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步。 
在Javadoc Generation对话框中有两个地方要注意的: 
javadoc command:应该选择jdk的bin/javadoc.exe 
destination:为生成文档的保存路径,可自由选择。 
按finish(完成)提交即可开始生成文档。 

2,用菜单选择:File->Export(文件->导出), 
剩下的步骤和第一种方法是一样的。 

3,选中要生成文档的项目,然后用菜单选择, 
Project->Generate Javadoc直接进入Javadoc Generation对话框,剩余的步骤就和第一种方法在Javadoc Generation对话框开始是一样的。

如果提示:编码 GBK 的不可映射字符 
eclipse 生成javadoc乱码问题解决 
如果源文件编码使用了utf-8编码,那么生成的文档可会有乱码,解决办法如下:
Generate javadoc时, 在第三个对话框的"Extra Javadoc options" 文本框里面加上
-encoding UTF-8 -charset UTF-8

即:

由于java源代码是用的UTF-8编码,Eclipse中默认编码是GB18030,因此,在生成javadoc的时候,需要手工指定一下编码和字符集。

解决方案是:

主菜单–>Project–>Generate javadoc–>next>next–> 在 “Extra javadoc options”下面的文本框中填入 ” -encoding UTF-8 -charset UTF-8 “.

参考:http://blog.csdn.net/seven_23/article/details/4584063

http://blog.csdn.net/wqjsir/article/details/5691254

javadoc,布布扣,bubuko.com

时间: 2024-10-10 05:12:29

javadoc的相关文章

初学JAVA随记——使用JAVADOC命令

1.控制台输入JAVADOC XXX.JAVA运行.JAVA文件. 2.双击文件夹下自动生成的index.html文件. 3.浏览器打开后即可显示. 注:Eclipse编写.JAVA文件,Tab键与源码下的“格式”可重排代码.

中文javadoc

大量的中文注释,其实最大的目的是想生成中文的Javadoc.但是中文注释实在太不高级了,在各种编码下还会变成乱码.本着高端大气国际化的思路,还是想把它换成英文,但是又不想放弃中文的Javadoc,怎么办呢? stackoverflow上有个帖子,说是在源码里写两种语言的注释,然后用过css切换.还有日本人用freemarker的语法来写Javadoc的http://www.ruimo.com/howto/java/javadoc-i18n/index_en.html.但是看到代码里一堆翻译文本也

Maven下载依赖项的源代码(source code)和Javadoc

Maven 默认只下载依赖项本身的 jar 文件,不下载源代码和 Javadoc.如此固然工程的体积是最小的,但在开发者不熟悉依赖的对象时,需要查找源代码中的方法定义和说明. 这时我们需要使用一条 Maven 命令将源代码和 Javadoc 下载到本地仓库. 代码清单 $ mvn dependency:sources -DdownloadSources=true -DdownloadJavadocs=true 该命令共两个参数,前者下载源代码,后者下载Javadoc.

Java - IntelliJ IDEA生成Javadoc

IntelliJ IDEA作为Java流行的编辑器, 其生成一些Javadoc会对中文乱码, 使用UTF-8编码即可. 这个常见的问题, 则需要生成时设置参数即可. 在 "Tools->Gerenate JavaDoc" 面版的 "Other command line arguments:" 栏里输入 "-encoding utf-8 -charset utf-8". 版权声明:本文为博主原创文章,未经博主允许不得转载.

读thinking in java的收获(二) --eclipse生成javadoc文档

最开始学习java语言的时候学过生成javadoc不过当时只是用windows命令行生成.读了这里的javadoc温故而知新发现其实我们做的项目就用到了一些注释,只是没有用eclipse 生成这份文档,通过查阅,最终补全了这份知识. 一.书中的代码: <pre name="code" class="java">//:object/HelloDate.java package unit2; import java.util.Date; /** * The

How to Write Doc Comments for the Javadoc Tool

http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html This document describes the style guide, tag and image conventions we use in documentation comments for Java programs written at Java Software, Oracle. It does not rehash r

【转载】解决使用Eclipse中调用javadoc的问题

出处:http://blog.163.com/[email protected]/blog/static/6256726420096259420870/ 像Microsoft Visual Studio 一样,使用Eclipse编写java代码时,将鼠标放在相应方法或字段等元素上时,会有对应的说明或提示. 不过,常出现下面的问题: Note:An exception occurred while getting the javadoc.see log for details. Note:This

JavaDoc的生成规则---ShinePans

用法: javadoc [options] [packagenames] [sourcefiles] [@files] -overview <file>          从 HTML 文件读取概览文档 -public                   仅显示 public 类和成员 -protected                显示 protected/public 类和成员 (默认值) -package                  显示 package/protected/p

javadoc注释规范

javadoc做注释 一. Java 文档 // 注释一行 /* ...... */ 注释若干行 /** ...... */ 注释若干行,并写入 javadoc 文档 通常这种注释的多行写法如下: /** * ......... * ......... */ javadoc -d 文档存放目录 -author -version 源文件名.java 这条命令编译一个名为 “源文件名.java”的 java 源文件,并将生成的文档存放在“文档存放目录”指定的目录下,生成的文档中 index.html

[笔记&amp;轮子]java源码 生成本地javadoc api文档

在用Eclipse写java代码时候,有时候因为不知道一个java函数的作用,会通过把鼠移动到java函数上,如果它有javadoc的相关内容就会显示出来.但是并非所有java代码都有javadoc:即使安装了javadoc,在eclipse中如果不进行设定,也可能无法使用. 我在win7下安装的是javase的jdk,发现eclipse中默认的javadoc路径是http://download.oracle.com/javase/7/docs/api/,显然这是一个在线资源,问题是网络总是不稳