用eclipse生成javadoc的时候发生“编码 GBK 的不可映射字符 ”其实是字符编码问题。
打开eclipse,project -> Generate javadoc 选择你要输出javadoc的项目-->next-->next在(VM options)设置中加入以下代码
-docencoding UTF-8 -encoding UTF-8
选择所需之修饰符范围
-public 仅显示 public 类和成员
-protected 显示 protected/public 类和成员 (缺省)
-package 显示 package/protected/public 类和成员
-private 显示所有类和成员
代码中需要增加注释之位置
注意:所有需要出现在javadoc中的注释,都是需要使用/** comment */的格式出现。
类定义的上方
在这里出现的注释,会出现在两个地方:一个是类列表中如果包含该类时,会出现注释的第一句话在右边;二是在该类的详细说明处,会出现所有的注释内容。
注意在注释和类定义之间,不要有空行。
方法定义的上方
在这里出现的注释,会出现在两个地方:一个是方法列表中如果包含该方法时,会出现注释的第一句话在右边;二是在该方法的详细说明处,会出现所有的注释内容。
注意在注释和方法定义之间,不要有空行。
参数定义的上方
在这里出现的注释,会出现在两个地方:一个是参数列表中如果包含该参数时,会出现注释的第一句话在右边;二是在该参数的详细说明处,会出现所有的注释内容。
注意在注释和方法定义之间,不要有空行。
注意:注释的第一句话的定义,在javadoc中定义是以“.”来定义的,并不是“。”。所以如果需要使用中文,你要注意了。
分享到:
相关推荐
在深入探讨如何使用Eclipse生成Javadoc文档之前,我们首先需要理解Javadoc的基本概念及其重要性。Javadoc是一种用于从Java源代码自动生成文档的工具,它通过解析代码中的注释来创建HTML格式的文档,这不仅有助于提高...
Eclipse生成javadoc Eclipse生成javadoc文档是将类、接口和方法的使用帮助信息嵌入到程序中,并将嵌入到程序中的文档注释信息提取出来,生成html格式的文档。生成javadoc文档的条件是:必须以/开头,以*/结尾来标注...
### Eclipse中设置javadoc中文帮助文档 #### 一、引言 在软件开发过程中,良好的文档支持对于提高工作效率至关重要。Eclipse作为一款广泛使用的集成开发环境(IDE),提供了丰富的功能来辅助开发者的工作。其中,...
- 如果你的项目很大,或者包含许多依赖的库,可能需要增加Eclipse生成Javadoc时的内存。在“Javadoc向导”的最后一步,有一个“Javadoc命令行”区域,在这里可以设置内存大小。例如,`-J-Xmx1024m`表示分配1024MB的...
Eclipse 是一个功能强大且流行的集成开发环境(IDE),而 Javadoc 是 Java 官方提供的 API 文档生成工具。然而,在 Eclipse 中配置 Javadoc 并不是一件容易的事情。本文将详细介绍如何解决 Eclipse 与 Javadoc 的...
Eclipse中自动生成Javadoc的方法,以及一些标签的含义
JAutodoc是一款专为Eclipse和MyEclipse开发者设计的高效插件,其主要功能是自动生成Javadoc代码,极大地提高了程序员编写文档的效率。在软件开发过程中,Javadoc是一种标准的注释方式,用于生成API文档,详细描述类...
本文将深入探讨Javadoc的基本概念、语法、以及如何在Android Studio、Eclipse和通过Javadoc命令行进行生成。 ### 1. Javadoc基本概念 Javadoc是Java的一个标准工具,它通过解析源代码中的特定注释格式,生成HTML...
这一段时间在研究Javadoc的问题,前面发布的Javadoc转换chm帮助文档的四种方法总结,总结了如何实现Javadoc到chm的转换,希望给大家带来了一些方便,今天我们来说说如何利用Eclipse生成个性化的Javadoc 文档,也希望...
Javadoc是Java编程语言的一个重要组成部分,它提供了文档生成工具,能够自动生成关于Java类库API的详细文档。 在"EMF 2.7.0 javadoc"中,我们可以找到关于EMF 2.7.0版本的API文档。这些文档详细地解释了EMF框架中的...
如果项目默认编码是UTF-8,但在生成Javadoc时不指定编码,可能会遇到GBK编码的不可映射字符警告,导致Javadoc无法正确生成。解决方法是在生成Javadoc时添加VM options,设置编码为UTF-8,即`-encoding UTF-8 -...
总结,使用Eclipse生成Javadoc文档是Java开发中不可或缺的一部分,它有助于提升代码的可读性和维护性。通过合理利用Javadoc注释和Eclipse的导出功能,可以轻松生成专业且详尽的API文档,促进团队间的有效合作。
2. **生成JavaDoc**:在Eclipse中,选择“Project” -> “Generate JavaDoc”。在弹出的对话框中,选择要生成JavaDoc的源代码位置,设置输出目录,并自定义文档样式、包和类的可见性等选项。 3. **转换为CHM**:...
针对于有需要控制JavaDoc生成内容的需求。对于使用了自定义注解的类才生成JavaDoc。且支持类和方法两个粒度。在类上使用就生成整个类的,在方法上生成就生成单个方法的。配合gradle task使用,具体代码可见本人博客...
解决这个问题的一个常见做法是在Eclipse中,通过Project->Generate Javadoc来逐项选择需要输出Javadoc的项目,然后在生成Javadoc的最后一步VM设置行中加入以下代码以确保使用UTF-8编码: -encoding utf-8 -charset ...
如果你不使用IDE或者想要更高级的定制,可以使用命令行来生成Javadoc文档。基本命令格式如下: ``` javadoc [options] [packagenames] [sourcefiles] [@files] ``` 其中: - **javadoc**:是生成Javadoc的命令,...
7. **版本升级**:从早期版本升级到2.0.0时,开发者需要注意可能存在的不兼容性或者API变动。JavaDoc可以帮助他们了解新版本引入的改变,以便进行相应的迁移工作。 8. **Eclipse插件开发**:Xtext通常作为Eclipse...
然而,默认情况下,Eclipse中的javadoc提示都是英文的,这对一些不熟悉英文的开发者来说是个不小的障碍。幸运的是,我们可以轻松地将Eclipse中的javadoc设置为中文,下面将详细介绍该过程。 javadoc是Java中的一个...
在使用Easy Javadoc时,开发者只需要在需要添加Javadoc的地方输入特定的快捷键(通常为`/**`后回车),插件会自动填充方法、类或接口的基本信息,如参数、返回值等。开发者只需根据提示补充具体的描述性文字,即可...