`
hellojim
  • 浏览: 53642 次
  • 性别: 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自带的一种工具,其可以从程序源代码中抽取类、方法、属性等注释形成一...

    jdk1.8 api中文doc文档

    JDK 1.8 API中文文档就是由Javadoc生成的,它提供了每个类、接口、方法和构造器的详细描述,包括参数、返回值、异常、示例代码等,是学习和查阅Java API的重要资源。 通过IDEA这样的集成开发环境,可以将这个中文...

    jdk_9_API文档

    **Java API文档是Java开发人员的重要参考资料,它包含了Java开发工具包(JDK)的所有类、接口、方法和常量的详细信息。JDK 9是Java发展历程中的一个重要版本,引入了许多新特性和改进,旨在提升性能、可移植性和安全...

    java jdk 21版 文档,要的速度下哈

    5. **Javadoc**:这是一个用于生成API文档的工具,JDK 21的Javadoc可能有新的注解或者格式改进,便于开发者生成更专业、易读的文档。 6. **JShell(REPL)**:Java 9引入的交互式命令行工具,允许开发者快速测试...

    JDK9 API文档 含英文中文

    **JDK9 API文档详解** Java Development Kit (JDK) 是Java编程语言的核心组件,它包含了一套完整的开发工具和Java运行环境。JDK9是Java的重要版本之一,引入了许多新特性和改进,以提高开发效率和应用程序性能。API...

    JDK13-javadoc-guide.pdf

    首先,需要编写Java源代码,然后使用Javadoc工具生成API文档。Javadoc工具支持多种命令行选项,可以根据需要选择输出格式、自定义文档结构等。 Javadoc配置选项 Javadoc工具提供了多种配置选项,例如可以选择输出...

    jdk17中文说明文档

    7. **开发工具:** Javadoc用于生成API文档,Javac是Java编译器,JConsole用于监视JVM性能,JProfiler进行深入性能分析等。 8. **新特性实验(JEPs):** JDK 17可能包含一些实验性的Java增强提案(JEPs),例如新...

    jdk9API中文文档,英文文档

    **JDK9 API 中文文档与英文文档详解** JDK(Java Development Kit)是Oracle公司提供的用于开发和运行Java应用程序的软件开发工具包。JDK9是Java平台标准版的一个重要版本,它引入了许多新特性,优化了性能,并对...

    JDK17-javadoc-guide.pdf

    这篇文档是关于JDK 17版本的JavaDoc指南,旨在帮助开发者了解如何使用JavaDoc工具来生成Java应用程序的文档。 Java Platform, Standard Edition Java Platform, Standard Edition(Java标准版)是Java开发平台的...

    Java JDK10.1中英双语API文档

    13. **Javadoc**: 使用Javadoc工具,可以从源代码中自动生成类似于这份API文档的格式化文档,方便他人阅读和使用你的代码。 通过深入学习和利用Java JDK 10.1的中英双语API文档,开发者能够全面了解Java平台的特性...

    jdk11 API文档 HTML版

    JDK11 API文档是Java 11的官方文档,提供了详细的类、接口和方法的描述,帮助开发者理解和使用Java 11的新功能。这些文档通常以HTML格式提供,方便在网页浏览器中查看和搜索,使得开发者可以快速查找和学习所需的...

    JDK16-javadoc-guide.pdf

    * 生成 API 文档:JavaDoc 工具可以生成 API 文档,帮助开发者快速了解 API 的使用和配置。 * 生成测试文档:JavaDoc 工具可以生成测试文档,帮助开发者快速了解测试用例和测试结果。 JavaDoc 工具的优势包括: *...

    jdk20--jdk-javadoc-guide.pdf

    JavaDoc 工具可以应用于各种场景,例如生成 API 文档、生成用户手册、生成技术文档等等。JavaDoc 工具可以帮助开发者快速生成高质量的文档,并且可以提高代码的可读性和理解性。 七、JavaDoc 工具的优点 JavaDoc ...

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

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

    中文版JDK帮助文档

    JDK包括了Java编译器(javac)用于将源代码转换为字节码,Java运行时环境(JRE)用于执行程序,还有一系列的开发工具,如Javadoc用于生成API文档,JDB用于调试,JAR用于打包等。JDK的不同版本可能会支持不同的Java...

    jdk6_api_javadoc

    其中,Javadoc是Java语言的官方文档生成工具,它能够自动生成关于Java源代码的详细文档,方便开发者理解和使用API。 JDK6的API包含了一系列核心类库,这些类库提供了丰富的功能,如集合框架、输入/输出处理、网络...

    jdk_api chinese

    JDK提供了Java运行环境(JRE)、Java编译器(javac)以及其他许多开发工具,如JAR工具、文档生成工具(javadoc)等。 #### JDK API概述 JDK API(Application Programming Interface)是指由JDK提供的一系列类和接口的...

    javadoc工具ydoc.jar

    JavaDoc工具是Java编程语言中一个非常重要的组成部分,主要用于生成API文档。它通过解析源代码中的注释,自动生成HTML格式的文档,使得开发者能够轻松地理解和使用代码库。`ydoc.jar` 是一个增强版的JavaDoc工具,...

    jdk 中文帮助文档

    4. **开发工具**:JDK包含了多个开发工具,如javac(编译器)、jar(打包工具)、javadoc(生成API文档)、jdb(调试器)等。了解这些工具的使用方法可以提高开发效率。 5. **JVM与性能调优**:文档会讲解Java...

    jdk1.6帮助文档中文版

    Javadoc是JDK自带的文档生成工具,可以将源代码中的注释转化为HTML格式的文档,方便开发者查阅和理解API。在JDK 1.6中,Javadoc也进行了一些改进,如支持更多的标签和选项,以及更好的文档布局和样式。 总之,JDK ...

Global site tag (gtag.js) - Google Analytics