`
accpxudajian
  • 浏览: 459829 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

eclipse导出javadoc文档

阅读更多

项目完成了,想把java源码生成doc文档,使用eclipse的export/javadoc就可以完成。


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

 


乱码问题:由于我们的java文件大部分都有中文,编码使用UTF-8,所以在生成doc文档的时候,需要明确设置编码格式:



解决方法:
Export后进入javadoc Generate 时, 点“next”进入第三个对话框时,在"Extra Javadoc options" 文本框里面加上

-encoding UTF-8 -charset UTF-8



java源码生成doc文档的必要性:

   - 内部交流更方便。

   - 便于新人更快了解项目。

   - 可以给用户看我们的源码结构。





愤怒的jser - doc文档很重要

 

分享到:
评论

相关推荐

    使用Eclipse生成Javadoc文档的方法

    在深入探讨如何使用Eclipse生成Javadoc文档之前,我们首先需要理解Javadoc的基本概念及其重要性。Javadoc是一种用于从Java源代码自动生成文档的工具,它通过解析代码中的注释来创建HTML格式的文档,这不仅有助于提高...

    JavaDoc生成API文档(powernode document)(源代码和导出的文档)

    JavaDoc生成API文档(powernode document)(内含源代码和导出的文档) 1.1 JavaDoc概述 1.2 文档注释的格式 1.3 IDEA生成API文档 vaDoc是Java自带的一种工具,其可以从程序源代码中抽取类、方法、属性等注释形成一...

    使用Eclipse将java类导成javadoc截图文档

    总结,使用Eclipse生成Javadoc文档是Java开发中不可或缺的一部分,它有助于提升代码的可读性和维护性。通过合理利用Javadoc注释和Eclipse的导出功能,可以轻松生成专业且详尽的API文档,促进团队间的有效合作。

    导出javadoc

    在Eclipse集成开发环境中,导出Javadoc的步骤如下: 1. 首先,打开Eclipse并选择你想要生成Javadoc的项目。这可以通过点击导航器视图中的项目,或者在"Package Explorer"或"Myelcipse"视图中选择项目来完成。 2. ...

    eclipse导出可运行的jar文件

    - “Packaging options” 部分提供了更多的自定义选项,如是否包含源代码、Javadoc 文档等。 5. **包含第三方类库**: - 在 “Libraries” 选项卡中,勾选 “Pack required libraries into generated JAR” 复选...

    生成Javadoc文档

    要生成Javadoc文档,可以使用Eclipse或其他集成开发环境(IDE)提供的功能,也可以直接使用命令行工具。下面将详细介绍这两种方法: ##### 使用Eclipse生成Javadoc 1. **打开Eclipse**:确保你已经安装了Eclipse IDE...

    eclipse中自动生成javadoc文档的方法

    在使用Eclipse开发Java项目的过程中,能够自动生成Javadoc文档是一项非常实用的技能。Javadoc是一种基于Java语言的API文档自动生成工具,它能够从源代码中的特定注释自动生成HTML格式的文档。这个过程对于团队协作、...

    docflex-doclet(1.6和1.7)两个版本.zip

    eclipse可以直接导出javadoc 文档(HTML),但是无法导出word版本。可使用此工具,使用如下: 1.下载DocFlex/Doclet 下载地址 http://www.filigris.com/downloads/ 2.ecplise->project->generate javadoc Use ...

    docflex-javadoc-1.6.1.zip

    这个工具的主要目的是帮助开发者创建高质量的Java API文档,通过自定义模板来生成专业且易于理解的Javadoc文档。"docflex-javadoc-1.6.1.zip"是一个包含该插件版本1.6.1的压缩文件。 在Java开发中,Javadoc是一种...

    Eclipse代码文档规范设置

    - 对于生成Javadoc文档,Eclipse提供了内置的支持。 - 在“Preferences”窗口中,找到“Java”->“Documentation”下的“Javadoc”。 - 这里可以设置Javadoc的默认模板,包括标签、链接、版式等。 - 要生成...

    Javadoc转换chm帮助文档的四种方法总结

    这些步骤可以通过IDE(如Eclipse或MyEclipse)的导出功能轻松完成。 接下来,我们将详细介绍四种常见的将Javadoc转换为CHM帮助文档的方法。 #### 第一种:使用JD2CHM生成CHM帮助文档 **原版JD2CHM**(版本0.3)...

    maven-javadoc-plugin 中文 注释 API 解决乱码 pom xml

    其中,`maven-javadoc-plugin`插件能够自动生成项目的Javadoc文档,帮助开发者更好地理解和维护代码。然而,在实际使用过程中,中文注释乱码和时间显示不准确的问题时常困扰着开发者。本文将详细介绍如何利用`maven-...

    eclipse代码格式化模板和注释javaDoc模板

    JavaDoc是一种标准的注释方式,用于生成文档,描述类、方法、变量等的用途和行为。`codetemplates.xml`文件则包含了这些预设模板。在`Window` > `Preferences` > `Java` > `Code Style` > `Code Templates`中,你...

    javaDoc转换成chm文件

    首先,需要安装该插件,然后在Eclipse的"导出"功能中选择"JavaDoc to CHM"选项,按照向导提示操作即可。 4. **使用自动化脚本**: 对于需要批量或自动化处理的情况,可以编写批处理脚本或者使用像Ant、Gradle这样...

    Java工具_自动生成技术文档

    在Eclipse中导出Javadoc文档时,可以在“Extra JavaDoc Options”中添加参数以解决中文乱码问题,例如: ```bash -encoding UTF-8 -charset UTF-8 ``` ##### 2. UmlGraph - 在Javadoc中嵌入UML图表 **简介:** ...

    Eclipse自动智能提示

    关于“Weblogic8.1相关的安全配置.doc”,这是与Eclipse无关的文档,主要涉及Oracle WebLogic Server 8.1的安全配置。WebLogic是一个企业级的Java应用服务器,安全配置包括用户认证、授权、SSL/TLS连接、访问控制等...

    JsdocJavadoc转换

    在eclipse中生成,在项目列表中按右键,选择Export(导出)然后在Export(导出)对话框中选择java下的javadoc,提交到下一步.在Javadoc Generation对话框中有两个地方要注意的: javadoc command:应该选择jdk的bin/...

    javadoc转chm (2).pdf

    标题提到的"javadoc转chm (2).pdf"是一个指南,描述了如何将Java的Javadoc文档转换成Microsoft的CHM(Compiled Help Manual)格式。CHM文件是一种常见的帮助文档格式,因其小巧且易于检索而被广泛使用。这个过程涉及...

    程序文档化的方法

    ### 程序文档化的方法:使用Eclipse生成文档(Javadoc) 在软件开发过程中,良好的文档对于提高代码可读性、便于维护和团队协作至关重要。Javadoc是一种为Java源代码自动生成文档的方式,它通过解析Java源文件中的...

Global site tag (gtag.js) - Google Analytics