`

javadoc的使用及eclipse生成

阅读更多

1.Eclipse文档注释生成方法:

1.项目-->右键菜单Export-->Java下Javadoc-->next:
<1>javadoc command:就是要调用的javadoc.exe,不用修改,eclipse会找到的;
<2>use standard doclet:就是要生成到的目录,自定义一个文件夹作为存放目录[不然一大堆];
<3>默认即可next-->再next-->
<4>【注意注意】此时如果项目采用的是UTF-8编码,Extra Javadoc options下需要输入设定参数:-encoding utf-8 -charset utf-8否则生成的网页中文注释都是乱码。
<5>最后Finish完成。
在工程的doc 目录中,就有Javadoc 文档了

 

-------------------------------- -------------风骚的分割线 ------------------------------------------------

 

2.javadoc的使用说明:

 

如何规范生成JAVADOC帮助文档


1.”文本注释“ =也叫归档注释。

"/** */"
归档注释是专用注释;
类或类成员声明之前;
javadoc工具提取它们来生成HTML文档。
归档注释:
1.类/接口/方法/字段生命之前。

 

2.“文档标记”

//以"@"开头的命令;
1.类文档标记
  ----包括:版本信息/作者。
(1)@version 版本信息:
        从生成的HTML提版本信息。
        对应"javadoc -version"
(2)@author 作者信息
        可包括:姓名/email。
        对应 "javadoc -author"
--------------------------------------
2.方法文档标记
  ----参数/返回值/异常。
(1)@param 参数名 说明
(2)@return 说明 指返回值的含义。
(3)@exception 完整类名 说明
    “完整类名”定义好的异常类名。
(4)@deprecated  不建议使用,将来可能摈弃。
 

3.只为 "public/protected" 处理注释文档。

"private"和"default" 注释会被忽略,看不到输出

可用-private标记包括private。

-------------------------------- -------------风骚的分割线 ------------------------------------------------

3.文档注释快捷键   

eclipse下,当鼠标处于类,方法定义行时,按Alt+Shift+J,快速添加文档注释。

设置默认格式:file > export > javadoc >

1
5
分享到:
评论
1 楼 tuspark 2015-10-18  
这里的:《javadoc设置》,讲解的很不错。

相关推荐

    使用Eclipse生成Javadoc文档的方法

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

    Eclipse生成javadoc

    Eclipse生成javadoc文档是将类、接口和方法的使用帮助信息嵌入到程序中,并将嵌入到程序中的文档注释信息提取出来,生成html格式的文档。生成javadoc文档的条件是:必须以/开头,以*/结尾来标注;要描述类的使用说明...

    02_Eclipse中设置javadoc中文帮助文档

    其中,javadoc是Java项目中常用的一种自动生成文档的方式,可以帮助开发者快速了解代码的功能和用法。然而,默认情况下,javadoc提供的文档通常是英文的,对于非英语母语的开发者来说,这可能会带来一定的理解障碍。...

    Javadoc详细讲解以及生成方式

    本文将深入探讨Javadoc的基本概念、语法、以及如何在Android Studio、Eclipse和通过Javadoc命令行进行生成。 ### 1. Javadoc基本概念 Javadoc是Java的一个标准工具,它通过解析源代码中的特定注释格式,生成HTML...

    如何解决eclipse与javadoc(java API)

    Eclipse 是一个功能强大且流行的集成开发环境(IDE),而 Javadoc 是 Java 官方提供的 API 文档生成工具。然而,在 Eclipse 中配置 Javadoc 并不是一件容易的事情。本文将详细介绍如何解决 Eclipse 与 Javadoc 的...

    使用Eclipse生成CHM帮助文档(图解)

    JavaDoc是Java编程语言的一个重要组成部分,它允许开发者通过在代码注释中使用特定的标签来生成文档。这些注释会被JavaDoc工具解析,生成HTML格式的文档,详细介绍类、接口、方法等。这对于理解代码结构和功能至关...

    如何用Eclipse创建javadoc

    - 如果你的项目很大,或者包含许多依赖的库,可能需要增加Eclipse生成Javadoc时的内存。在“Javadoc向导”的最后一步,有一个“Javadoc命令行”区域,在这里可以设置内存大小。例如,`-J-Xmx1024m`表示分配1024MB的...

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

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

    javadoc eclipse

    在Eclipse中使用JavaDoc主要有以下几个步骤: 1. **创建JavaDoc注释**: 在编写Java源代码时,为类、方法、变量等添加JavaDoc注释。注释通常以`/**`开始,以`*/`结束,中间内容使用`@param`、`@return`、`@throws`...

    Eclipse生成Java doc

    总结来说,Eclipse生成Java doc是一个高效且便捷的过程,通过合理地使用Java doc注释和Eclipse的向导功能,可以快速为项目创建高质量的文档,提高代码的可维护性和团队合作效率。对于任何Java开发者来说,掌握这项...

    如何个性化地生成Javadoc文档

    这一段时间在研究Javadoc的问题,前面发布的Javadoc转换chm帮助文档的四种方法总结,总结了如何实现Javadoc到chm的转换,希望给大家带来了一些方便,今天我们来说说如何利用Eclipse生成个性化的Javadoc 文档,也希望...

    jautodoc 插件 myeclipse eclipse 自动生成javadoc代码 天涯浪子

    JAutodoc是一款专为Eclipse和MyEclipse开发者设计的高效插件,其主要功能是自动生成Javadoc代码,极大地提高了程序员编写文档的效率。在软件开发过程中,Javadoc是一种标准的注释方式,用于生成API文档,详细描述类...

    Eclipse中设置中文件javadoc

    如果我们想在Eclipse中使用中文javadoc提示,需要下载中文javadoc的压缩包,并将其配置到Eclipse中。下面将详细介绍该过程。 首先,需要下载中文javadoc的压缩包。我们可以从Oracle的官方网站上下载javaSE6.0的中文...

    在Eclipse中导入中文JavaDOC

    本文将深入探讨如何在Eclipse这一流行的集成开发环境(IDE)中导入并使用中文JavaDoc,这对于非英语母语的开发者来说尤其重要。 ### 一、JavaDoc与Eclipse JavaDoc是一种自动生成API文档的工具,它允许程序员通过...

    eclipse EMF javadoc

    Javadoc是Java编程语言的一个重要组成部分,它提供了文档生成工具,能够自动生成关于Java类库API的详细文档。 在"EMF 2.7.0 javadoc"中,我们可以找到关于EMF 2.7.0版本的API文档。这些文档详细地解释了EMF框架中的...

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

    JavaDoc生成API文档(powernode document)(内含源代码和导出的文档) 1.1 JavaDoc概述 1.2 文档注释的格式 1.3 IDEA生成API文档 vaDoc是Java自带的一种工具,其...我们可以通过Eclipse来实现Java文件的API文档生成。

    规范生成Javadoc帮助文档

    Eclipse中自动生成Javadoc的方法,以及一些标签的含义

    生成Javadoc文档

    ##### 使用Eclipse生成Javadoc 1. **打开Eclipse**:确保你已经安装了Eclipse IDE。 2. **选择项目**:在项目资源管理器中找到并选中需要生成文档的项目。 3. **导出Javadoc**:右键点击项目,选择“导出”(Export...

    eclipse Xtext javadoc

    总的来说,"Xtext 2.0.0 JavaDoc"是学习和使用Xtext构建DSL的关键参考资料,它涵盖了从语言设计到代码生成,再到文档生成的全过程,对于任何希望利用DSL提升软件开发效率的开发者来说都是一份宝贵的资源。

Global site tag (gtag.js) - Google Analytics