[JAVA] JAVA 文档注释
Java 程序设计环境
文档注释
javadoc
JDK中包含的javadoc工具可以由源文件生成一个HTML文档。
javadoc从以下几个特性中抽取信息
- 包
- 公有类与接口
- 公有的和受保护的构造器及方法
- 公有的和受保护的域
包注释：
- 提供一个以package.html命名的HTML文件，body之间的所有文本都会被抽取出来。
- 提供一个以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 文档注释的更多相关文章
- [java基础]文档注释
转载自:http://blog.163.com/hui_san/blog/static/5710286720104191100389/ 前言 Java 的语法与 C++ 及为相似,那么,你知道 Jav ...
- Java的文档注释之生成帮助文档
示例: /** * Title: Person类<br/> * Description:通过Person类说明Java中的文档注释<br/> * Company: *** * ...
- java文档注释--javadoc的用法
1.前言 Java中有三种注释方式.前两种分别是 // 和 /* */,主要用于代码的注释,以此来方便代码的可读性.第三种被称作说明注释或文档注释,它以 /** 开始,以 */结束,文档注释允许你在程 ...
- Java 文档注释
Java只是三种注释方式.前两种分别是// 和/* */,第三种被称作说明注释,它以/** 开始,以 */结束. 说明注释允许你在程序中嵌入关于程序的信息.你可以使用javadoc工具软件来生成信息, ...
- JAVA 文档注释，类的说明，HTML说明文档的生成
有的时候,我们会写一些类,编译成.class文件,给别人使用,那么,别人不知道这个类有哪些方法,如何调用. 所以我们需要做一个类的说明文档. 可以采用在.java类里面进行注释,通过注释来生成类的说明 ...
- java文档注释主要使用方法
一.java包含哪些注释 1.//用于单行注释. 2./*...*/用于多行注释,从/*开始,到*/结束,不能嵌套. 3./**...*/则是为支持jdk工具javadoc.exe而特有的注释语句.这 ...
- Java文档注释
文档注释是用于生成API文档,API主要用于说明类.方法.成员变量 javadoc工具 处理文档源文件在类.接口.方法.成员变量.构造器和内部类之前的注释,忽略其他地方的文档注释.而且javadoc工 ...
- Java：API文档；文档注释中的javadoc标记；官方API；自己动手给项目建一个API文档
1.什么是API文档 在Java语言中有3种注释 //单行注释 /* 多行注释 */ /** * 文档注释 */ API(应用程序接口)文档就是用javadoc命令提取文档注释生成的,html格式,用 ...
- Effective Java 第三版——56. 为所有已公开的API元素编写文档注释
Tips 书中的源代码地址:https://github.com/jbloch/effective-java-3e-source-code 注意,书中的有些代码里方法是基于Java 9 API中的,所 ...
- Java - 34 Java 文档注释
Java 文档注释 Java只是三种注释方式.前两种分别是// 和/* */,第三种被称作说明注释,它以/** 开始,以 */结束. 说明注释允许你在程序中嵌入关于程序的信息.你可以使用javadoc ...
随机推荐
- 07 go语言
Home Alexey Palazhchenko edited this page on 9 Jul · 89 revisions Welcome to the Go wiki, a collec ...
- 奇妙的CSS之伪类与伪元素
我们都知道,在CSS中有很多选择器,例如id(#), class(.),属性[attr],这些虽然可以满足一些需要,但有时候还力有未逮.伪类和伪元素就提供了一个有益的补充,可以使我们更高效编码.伪类和 ...
- CxGrid 表格列内容居中
首先每一列 Cxgrid 都不知道要当成什么来出来,所以每一列都有个properties 让你来设置,告诉cxgrid 这列的内容是什么,然后根据你给出的内容 再来决定用什么居中方式: 就是说 官方再 ...
- TypeScript 2 : 获取当前日期及前后范围日期【Array】
前言 今天有个接口字段需求,要写一个今天及前几天的日期传过去: 在网上找了下都木有什么比较好的方案:就自己写了一个. 因为技术栈就是NG2+TS2+WEBPACK,这里的代码需要一定的TS2及ES6的 ...
- R语言学习笔记：choose、factorial、combn排列组合函数
一.总结 组合数:choose(n,k) —— 从n个中选出k个 阶乘:factorial(k) —— k! 排列数:choose(n,k) * factorial(k) 幂:^ 余数:%% 整数商: ...
- node模拟socket
什么是Socket?网络上的两个程序通过一个双向的通信连接实现数据的交换,这个连接的一端称为一个socket. Socket通信流程 基于net模块实现socket 服务端SocketServer.j ...
- Pg188-3 构造方法
package org.hanqi.array; public class Father { private String name; private int age; public String g ...
- jboss各种测试方式归类
不跨工程访问(如:HBase) 跨工程访问(如:Business) 不部署到服务器上 部署到服务器上 不部署到服务器上 部署到服务器上 Junit测试 实例化直接调用 true true Fals ...
- Ubuntu下编译安装OpenCV 2.4.7并读取摄像头
主要参考: 1.http://www.ozbotz.org/opencv-installation/ 2.http://www.ozbotz.org/opencv-install-troublesho ...
- Django实战（10）：单元测试
尽早进行单元测试(UnitTest)是比较好的做法,极端的情况甚至强调“测试先行”.现在我们已经有了第一个model类和Form类,是时候开始写测试代码了. Django支持python的单元测试(u ...