Java 程序设计环境

文档注释

javadoc

JDK中包含的javadoc工具可以由源文件生成一个HTML文档。

javadoc从以下几个特性中抽取信息

  • 包
  • 公有类与接口
  • 公有的和受保护的构造器及方法
  • 公有的和受保护的域

包注释：

  1. 提供一个以package.html命名的HTML文件，body之间的所有文本都会被抽取出来。
  2. 提供一个以package-info.java命名的文件，包含在/**和*/界定的javadoc注释，跟随在一个包语句之后，它不应该包含更多代码或注释。

生成文档

mac-abeen:java abeen$ ls

alearnJava   doc_html     javasrc      package.html

mac-abeen:java abeen$ javadoc -d doc_html/  alearnJava

正在加载程序包alearnJava的源文件...

正在构造 Javadoc 信息...

标准 Doclet 版本 9.0.4

正在构建所有程序包和类的树...

正在生成doc_html/alearnJava/BaseClassDescription.html...

正在生成doc_html/alearnJava/Employee.html...

正在生成doc_html/alearnJava/HelloSwing.html...

正在生成doc_html/alearnJava/Person.html...

正在生成doc_html/alearnJava/Reflect.html...

正在生成doc_html/alearnJava/Test.html...

正在生成doc_html/alearnJava/Welcome.html...

正在生成doc_html/alearnJava/package-frame.html...

正在生成doc_html/alearnJava/package-summary.html...

正在生成doc_html/alearnJava/package-tree.html...

正在生成doc_html/constant-values.html...

正在构建所有程序包和类的索引...

正在生成doc_html/overview-tree.html...

正在生成doc_html/index-all.html...

正在生成doc_html/deprecated-list.html...

正在构建所有类的索引...

正在生成doc_html/allclasses-frame.html...

正在生成doc_html/allclasses-frame.html...

正在生成doc_html/allclasses-noframe.html...

正在生成doc_html/allclasses-noframe.html...

正在生成doc_html/index.html...

正在生成doc_html/help-doc.html...

mac-abeen:java abeen$

[JAVA] JAVA 文档注释的更多相关文章

  1. [java基础]文档注释

    转载自:http://blog.163.com/hui_san/blog/static/5710286720104191100389/ 前言 Java 的语法与 C++ 及为相似,那么,你知道 Jav ...

  2. Java的文档注释之生成帮助文档

    示例: /** * Title: Person类<br/> * Description:通过Person类说明Java中的文档注释<br/> * Company: *** * ...

  3. java文档注释--javadoc的用法

    1.前言 Java中有三种注释方式.前两种分别是 // 和 /* */,主要用于代码的注释,以此来方便代码的可读性.第三种被称作说明注释或文档注释,它以 /** 开始,以 */结束,文档注释允许你在程 ...

  4. Java 文档注释

    Java只是三种注释方式.前两种分别是// 和/* */,第三种被称作说明注释,它以/** 开始,以 */结束. 说明注释允许你在程序中嵌入关于程序的信息.你可以使用javadoc工具软件来生成信息, ...

  5. JAVA 文档注释，类的说明，HTML说明文档的生成

    有的时候,我们会写一些类,编译成.class文件,给别人使用,那么,别人不知道这个类有哪些方法,如何调用. 所以我们需要做一个类的说明文档. 可以采用在.java类里面进行注释,通过注释来生成类的说明 ...

  6. java文档注释主要使用方法

    一.java包含哪些注释 1.//用于单行注释. 2./*...*/用于多行注释,从/*开始,到*/结束,不能嵌套. 3./**...*/则是为支持jdk工具javadoc.exe而特有的注释语句.这 ...

  7. Java文档注释

    文档注释是用于生成API文档,API主要用于说明类.方法.成员变量 javadoc工具 处理文档源文件在类.接口.方法.成员变量.构造器和内部类之前的注释,忽略其他地方的文档注释.而且javadoc工 ...

  8. Java：API文档；文档注释中的javadoc标记；官方API；自己动手给项目建一个API文档

    1.什么是API文档 在Java语言中有3种注释 //单行注释 /* 多行注释 */ /** * 文档注释 */ API(应用程序接口)文档就是用javadoc命令提取文档注释生成的,html格式,用 ...

  9. Effective Java 第三版——56. 为所有已公开的API元素编写文档注释

    Tips 书中的源代码地址:https://github.com/jbloch/effective-java-3e-source-code 注意,书中的有些代码里方法是基于Java 9 API中的,所 ...

  10. Java - 34 Java 文档注释

    Java 文档注释 Java只是三种注释方式.前两种分别是// 和/* */,第三种被称作说明注释,它以/** 开始,以 */结束. 说明注释允许你在程序中嵌入关于程序的信息.你可以使用javadoc ...

随机推荐

  1. cocos2d-x 日志...

    cocos2d-x  日志... http://blog.csdn.net/themagickeyjianan/article/details/39008297http://blog.csdn.net ...

  2. docker stack 部署 mysql 5.6

    =============================================== 2018/7/1_第1次修改                       ccb_warlock === ...

  3. java IO流知识点总结

    I/O类库中使用“流”这个抽象概念.Java对设备中数据的操作是通过流的方式.表示任何有能力产出数据的数据源对象,或者是有能力接受数据的接收端对象.“流”屏蔽了实际的I/O设备中处理数据的细节.IO流 ...

  4. Java 泛型和类型安全的容器

    使用java SE5之前的容器的一个主要问题就是编译器允许你向容器插入不正确的类型,例如: //: holding/ApplesAndOrangesWithoutGenerics.java // Si ...

  5. 触发器中的inserted表和deleted表

    触发器语句中使用了两种特殊的表:deleted 表和 inserted 表.Microsoft? SQL Server 2000 自动创建和管理这些表.可以使用这两个临时的驻留内存的表测试某些数据修改 ...

  6. Java读取本地文件（输入流）

    package cn.buaa; import java.io.File; import java.io.FileInputStream; import java.io.FileReader; imp ...

  7. PHP array_diff 计算数组的差集

    array_diff (PHP 4 >= 4.0.1, PHP 5) array_diff — 计算数组的差集 说明 array array_diff ( array $array1 , arr ...

  8. C#重写ToString

    C# 中的每个类或结构都可隐式继承 <xref:System.Object> 类. 因此,C# 中的每个对象都会获取 <xref:System.Object.ToString%2A& ...

  9. JDBC连接池和DBUtils

    本节内容: JDBC连接池 DBUtils 一.JDBC连接池 实际开发中“获得连接”或“释放资源”是非常消耗系统资源的两个过程,为了解决此类性能问题,通常情况我们采取连接池技术,来共享连接Conne ...

  10. 15 链表中倒数第k个结点

    输入一个链表,输出该链表中倒数第k个结点. p1先走k-1步,p1 p2再一起走 C++: /* struct ListNode { int val; struct ListNode *next; L ...