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. 练习题 --- 10种Xpath定位

    写出10种不同的Xpath定位语法

  2. 洛谷P1782 旅行商的背包

    传送门啦 这个题不用二进制优化的话根本不行,现学的二进制优化,调了一段时间终于A了,不容易.. 如果不懂二进制优化的话可以去看我那个博客 二进制优化多重背包入口 不想TLE,不要打memset,一定要 ...

  3. thinkphp模型创建

  4. 多路复用IO与NIO

    最近在学习NIO相关知识,发现需要掌握的知识点非常多,当做笔记记录就下. 在学NIO之前得先去了解IO模型 (1)同步阻塞IO(Blocking IO):即传统的IO模型. (2)同步非阻塞IO(No ...

  5. Kafka（五）Kafka的API操作和拦截器

    一 kafka的API操作 1.1 环境准备 1)在eclipse中创建一个java工程 2)在工程的根目录创建一个lib文件夹 3)解压kafka安装包,将安装包libs目录下的jar包拷贝到工程的 ...

  6. Spark（十一）Spark分区

    一.分区的概念 分区是RDD内部并行计算的一个计算单元,RDD的数据集在逻辑上被划分为多个分片,每一个分片称为分区,分区的格式决定了并行计算的粒度,而每个分区的数值计算都是在一个任务中进行的,因此任务 ...

  7. day7 反射

    反射是python开发中常用的功能,伴随开发的整个过程,因此要熟练掌握反射的用法. 反射常用的函数有四个:hasattr().getattr().setattr()和delattr()四个反射的函数. ...

  8. 【LOJ】#2674. 「NOI2012」美食节

    题解 这道题的费用流如果朴素一点怎么建边呢 建出\(\sum_{i = 1}^{n} p^{i} M\)个点,第\(i\)个厨师的第\(j\)个点表示这个厨师倒数第\(j\)个做的是某道菜 这个点向汇 ...

  9. log4j:WARN No appenders could be found for logger (org.springframework.web.context.ContextLoader).

    一.异常描述: log4j:WARN No appenders could be found for logger (org.springframework.web.context.ContextLo ...

  10. 8VC Venture Cup 2016 - Final Round (Div. 1 Edition) E - Preorder Test 树形dp

    E - Preorder Test 思路:想到二分答案了之后就不难啦, 对于每个答案用树形dp取check, 如果二分的值是val, dp[ i ]表示 i 这棵子树答案不低于val的可以访问的 最多 ...