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. 转载： Android开源库V - Layout：淘宝、天猫都在用的UI框架，赶紧用起来吧！

    阿里的UI库... 分析的很精辟... http://blog.csdn.net/carson_ho/article/details/71077193

  2. Python匿名函数详解

    python 使用 lambda 来创建匿名函数. lambda这个名称来自于LISP,而LISP则是从lambda calculus(一种符号逻辑形式)取这个名称的. 在Python中,lambda ...

  3. C++链接与装载

    1..obj文件的内部结构 2.映射到进程虚拟空间 3.链接的原理    C++ Code  123456789   1.未解决符号表:提供了所有在该编译单元里引用但是定义并不在本编译单元里的符号及其 ...

  4. （一）问候MyBatis3

    第一节:MyBatis简介 百度百科 第二季:Mybatis版HolleWorld实现 例子: mybatis-config.xml: <?xml version="1.0" ...

  5. TypeScript 2 : 获取当前日期及前后范围日期【Array】

    前言 今天有个接口字段需求,要写一个今天及前几天的日期传过去: 在网上找了下都木有什么比较好的方案:就自己写了一个. 因为技术栈就是NG2+TS2+WEBPACK,这里的代码需要一定的TS2及ES6的 ...

  6. sql查询与修改数据库逻辑文件名，移动数据库存储路径

    USE mydb GO --1.查询当前数据库的逻辑文件名 ) ) AS 'File Name 2'; --或通过以下语句查询: --SELECT name FROM sys.database_fil ...

  7. RelativeLayout

    <?xml version="1.0" encoding="utf-8"?> <RelativeLayout xmlns:android=&q ...

  8. jQuery类名添加click方法

    通过$("").jQuery为元素添加点击事件,在使用类的情况下,可以使用$(e.target).attr('title');获得被点击元素的属性值. 示例代码如下 $(" ...

  9. javascript 去除最后一个字符自定义的方法

    //公共去除最后字符方法 function dtrim(str, s){ var reg = eval("/"+s+"$/gi"); str=str.repla ...

  10. 使用Let’s Encrypt创建nginx免费SSL证书

    资料参考: https://www.freehao123.com/top-8-free-ssl-cert/   八大免费SSL证书-给你的网站免费添加Https安全加密 https://www.fre ...