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

使用javadoc工具生成类似 jdk API 形式的文档

    博客分类:
  • JAVA
JDK 
阅读更多
/** 
* Title: User 类<br>
* Description: 通过 User 类说明 javadoc 如何使用<br>
* Copyright: http://hellojim.iteye.com<br>
* Company: hellojim <br>
* @author: jim
* @version:1.0
*/
public class User { //生成帮助文档时,class 前必须加上 public
	private String username;
	private String password;
	
	/** 
	*这是 User 类的构造方法
	*@param username 用户名
	*@param password 密码
	*/
	public User(String username,String password) {
		this.username = username;
		this.password = password;
	}
	
	/** 
	*此方法用户获得一个用户
	*@param type 获得的是普通用户还是管理员
	*@return user 返回一个用户 
	*/
	public User getUser(boolean type) {
		
		if(type) {
			return user;
		}else {
			return (Obj)user;
		}
	}
}
提醒:此外还要注意 (@author、@version、@param、@return 以及 /**  */ ) 
这些最过运用 (javadoc  -d  help  -version -author  User.java) 这样的命令语句来生成帮助文档
 
分享到:
评论

相关推荐

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

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

    JavaDoc生成API文档(powernode CD2207)(教学视频+源代码)

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

    Java API文档.docx

    在JDK中,有一个命令行工具javadoc,可以通过指定要包含的类、接口和方法等参数来生成Java API文档。生成的Java API文档可以保存为HTML文件,并可以在Web浏览器中查看和浏览。在许多集成开发环境(IDE)中,例如...

    JAVA帮助文档全系列 JDK1.5 JDK1.6 JDK1.7 官方中英完整版下载地址

    ·javadoc – 文档生成器,从源码注释中提取文档 ·jdb – debugger,查错工具 JDK中还包括完整的JRE(Java Runtime Environment,Java运行环境),也被称为private runtime。包括了用于产品环境的各种库类,...

    JDK1.8(32位和64位)正式版+JDK1.8API帮助文档

    javadoc – 文档生成器,从源码注释中提取文档 jdb – debugger,查错工具 java – 运行编译后的java程序(.class后缀的) appletviewer:小程序浏览器,一种执行HTML文件上的Java小程序的Java浏览器。 Javah:产生...

    JAVA帮助文档全系列_JDK1.5_、JDK1.6、_JDK1.7_官方中英完整版下载

    ·javadoc – 文档生成器,从源码注释中提取文档 ·jdb – debugger,查错工具 JDK中还包括完整的JRE(Java Runtime Environment,Java运行环境),也被称为private runtime。包括了用于产品环境的各种库类,...

    配制eclipse使用JDK1.5中文JavaAPI

    配制 eclipse 使用JDK1.5中文 JavaAPI 1 Sun 官方的中文版 Java API 文档发布了,地址为:...我们知道JAVA的API文档就是通过源代码中的注释生成的,可是源代码中的注释并没有被汉化.所以显示的API提示自然是英文的.

    JAVA 开发环境 Java SE Development Kit (JDK) 16.0.1 x64 免费下载.zip

    除了这些工具之外,JDK 还提供了注释处理工具,用于 JAR 文件冲突检测的 extcheck,Java 编译器的 idlj IDL,使用源代码注释的 javadoc 文档生成器或 Javadoc 文档生成器。 jar`归档程序,将单个 JAR 文件中的相关类...

    win64位 jdk6,jdk7,jdk8版本 开发工作可以用到,为不方便在官网下载小伙伴分享

    javadoc:文档生成器,从源码注释中提取文档。 jdb:debugger,差错工具。 JDK中还包括完整的JRE(java runtime environment,Java运行环境),也被称为Private Runtime,包含了用于产品环境的各种类库,以及给开发...

    Java 的注释 生成代码文档.pdf

    我们都阅读过 JDK API,但是庞大的API文档是怎么生成的?有谁知道 如何能保持代码的修改与代码文档的同步?这就是 javadoc 的存在目的。 这个文档将详细讲解 代码注释 怎么成为代码说明文档。

    JAVA 开发环境 Java SE Development Kit (JDK) 16.0.1 x64.zip

    除了这些工具之外,JDK 还提供了注释处理工具,用于 JAR 文件冲突检测的 extcheck,Java 编译器的 idlj IDL,使用源代码注释的 javadoc 文档生成器或 Javadoc 文档生成器。 jar`归档程序,将单个 JAR 文件中的相关类...

    jdk8安装超详细教程,两种配置环境变量方法

    3. **工具集**:JDK还包括一系列开发者工具,如Java打包工具(jar)、Java文档生成工具(javadoc)、Java调试器(jdb)、Java性能分析工具(Java VisualVM)等,这些工具极大地便利了Java应用的开发和维护过程。

    GroovyHelp 3.2.0 RC

    * 支持JDK1.4+(JDK1.4 ~ JDK7)自带的Javadoc生成的帮助文档 * 无需解压文档及源码ZIP压缩包,节省磁盘空间 * 支持在线的Javadoc(比如jexcelapi的在线Javadoc ) * 用户可以自由选择所需的jre1.6.0+(可通过...

    JavadocToolUI:JavadocToolUI可帮助您创建自定义的API文档。-开源

    该工具使用在Oracle JDK Javadoc实用程序下指定的大多数可用选项。 有关使用Javadoc实用程序的更多信息,请访问Oracle的Javadoc主页,网址为https://docs.oracle.com/en/java/javase/12/tools/javadoc.html。 注意...

    phpdoc1beta

    PHPDoc是PEAR下面的一个非常优秀的模块,它的目标是实现类似javadoc的功能,可以为你的代码快速生成具有相互参照,索引等功能的API文档。如果你使用过javadoc生成的文档(如jdk的文档),你会非常清楚.

    apiface:一套java自动生成接口并支持用例测试的工具(在操作或开发环境中运行的工具)

    市面上的接口文档琳琅满目,但是要找到一个适合自己的接口文档确实有点难度,诸如传统的api文档上有一下几方面的问题。 * 1.文档更新慢,造成占用团队协作时间太多 * 2.传统javadoc太老了,不符合现在发展趋势 * ...

    《Java基础复习》—规范与基础

    参考书目《Java 编程思想》所以大家放心食用 ...② 注释内容可以被JDK提供的工具 javadoc 所解析,生成一套以网页文件形式体现的该程序的说明文档。 ③ 多行注释不可以嵌套使用 2.Java API 文档 API: Applic

    计算型验证码及springboot集成部署

    技术上采用JDK+JUnit,内含测试用例,注释丰富,结构清晰,有javadoc生成的api文档。 springboot验证程序,主要是将验证码jar包集成到springboot中,在网页中进行验证,分为jar部署和war部署两种方式,内部同样注释...

    Java注解Annotation

    @param @return @Exeception 从根本上是一个注释,不存在代码编译,不会生成对应的.class字节码问题,只是提供给JavaDoc API文件生成工具。作为标记生成对应的文档。 注解是有一部分参与编译 @Ov

    Day 27 注解

    Day 27 1. 注解 1.1 注解解释 注释: 解释代码,给程序员看的 注解: Java语言中的类、方法、变量、参数和包等都可以被标注。和Javadoc不同,Java标注可以通过... 代码中生成对应的JavaDoc API文档 @param @return

Global site tag (gtag.js) - Google Analytics