JAVADOC注释详解
java注释的分类
1、单行注释:int SUM = 100; //这是一个单行注释
2、多行注释:
/*
*这是一个多行注释
*/
3、文档注释:
/**
*这是一个文档注释
* @return a
*/
java注释和文档注释
作为一个java程序员我们一定都喜欢看官方的开发文档,文档中很详细的包括了类和接口参数方法等信息,并提供了许多类之间的关系等等。java的开发文档是由HTML页面进行展示的,但是用了很久我们才知道,这些文档实际上不是一点一点的写出来的,我们自己也可以进行生成。
安装了 JDK 之后,安装目录下有一个 src.jar 文件或者 src.zip 文件,它们都是以 ZIP 格式压缩的,可以使用 WinZip 解压。解压之后,我们就可以看到分目录放的全是 .java 文件。是了,这些就是 Java 运行类的源码了,非常完整,连注释都写得一清二楚,我们可以对比这里的注释和开发文档,以java.util.List为例:这是官网API截图
接下来再看一下源码信息:
package java.util;
/**
* An ordered collection (also known as a <i>sequence</i>). The user of this
* interface has precise control over where in the list each element is
* inserted. The user can access elements by their integer index (position in
* the list), and search for elements in the list.<p>
*
* Unlike sets, lists typically allow duplicate elements. More formally,
* lists typically allow pairs of elements <tt>e1</tt> and <tt>e2</tt>
* such that <tt>e1.equals(e2)</tt>, and they typically allow multiple
* null elements if they allow null elements at all. It is not inconceivable
* that someone might wish to implement a list that prohibits duplicates, by
* throwing runtime exceptions when the user attempts to insert them, but we
* expect this usage to be rare.<p>
*
* The <tt>List</tt> interface places additional stipulations, beyond those
* specified in the <tt>Collection</tt> interface, on the contracts of the
* <tt>iterator</tt>, <tt>add</tt>, <tt>remove</tt>, <tt>equals</tt>, and
* <tt>hashCode</tt> methods. Declarations for other inherited methods are
* also included here for convenience.<p>
.....
* @param <E> the type of elements in this list
*
* @author Josh Bloch
* @author Neal Gafter
* @see Collection
* @see Set
* @see ArrayList
* @see LinkedList
* @see Vector
* @see Arrays#asList(Object[])
* @see Collections#nCopies(int, Object)
* @see Collections#EMPTY_LIST
* @see AbstractList
* @see AbstractSequentialList
* @since 1.2
*/
public interface List<E> extends Collection<E> {
.....
}
可以看出来,java的开发文档其实就是在将代码中的注释按照相应的规则整理出来的,这对程序的阅读者和使用者十分关键,由此可见,学会写注释对于一个程序员来说是十分关键的,也能体现一个程序员的水平。
文档和文档注释的格式
文档注释可以用在类,方法,属性上进行说明。文档内部要注意细节问题。
文档的生成格式是HTML,而HTML中的格式标识符并不是javadoc加的,而是我们在写注释的时候写上去的,比如,需要换行的时候,不是敲入一个换行符,而是写一个<br>,如果要分段,需要使用<p>
因此,格式化文档,就是在注释中添加HTML相应的标签。
文档注释的正文并不是直接复制到输出文件 (文档的 HTML 文件),而是读取每一行后,删掉前导的 * 号及 * 号以前的空格,再输入到文档的。如:
/**
* This is first line. <br>
* This is second line. <br>
This is third line.
*/
编译输出后的HTML源码则是:
This is first line. <br>
This is second line. <br>
This is third line.
*注意,文档说明后面需要紧跟类、接口、方法或属性
文档注释的三个组成部分
第一个部分作为类、接口、方法、属性的简述。简述在文档注释的最前面,简述的末尾需要加上一个点号“.”,就是使用点号来分割文档注释,有的时候点号会出现错误,我们就用<p>作为第二部分的开头进行分割。
第二部分就是注释的详细部分,对属性或方法等进行详细的说明,在格式上没有什么特殊的要求。
第三部分是特殊说明部分,这个部分包括声明作者、版本说明、参数说明、参考说明、返回值说明。抛出异常说明等,这一部分最好和第二部分有一个空行,不然可能会出现错误。
常用的javadoc标记及其使用
1、@see的使用:
@see的句法有三种
①、@see 类名
类名可以根据需要只写出类名,如String,或者写出全名:java.lang.String,但需要注意的是,在用类名的时候需要这个java源文件中import这个类,否则只能用全名。
②、@see#方法名或属性名
如果是属性名,则只需要写出属性名即可,如果是方法名,则需要写出方法名以及参数类型,如果没有参数,也需要写出一对括号。
如:@see #contains(Object)、@see #count()、@see number
③、@see 类名#方法名或属性名
如:@see Object#equals(Object)、@see java.lang.String#toString()
2、@author、@version的使用:
这两个标记分别指明作者和版本号,缺省情况下javadoc自动将其忽略,但命令行开关-author和-version可以修改个功能,使其包含的信息流输出,这两个标记都可以多个使用,但是版本号只有第一个出现的有效。
3、@param、@return和@exception的使用:
这三个标记只能用于方法,@param描述参数,@return描述返回值,@exception描述抛出异常,用法如下:
①、@param 参数名 参数说明
每一个@param都只能描述一个方法的参数,可以多次使用。
②、@return 返回值说明
一个方法只能使用一个@return,如果有多个,javadoc会发出警告,并且只有第一个声明的有效。
@exception 异常类名 异常说明
@exception可以多次使用,并且异常的类名需要注意在java原文件中是否有导入,如果没有需要写类全名。
如:
/**
* test 方法的简述,这个方法用于做javadoc的测试.
* <p> test方法的详细说明,这里是详细说明的第一行<br>
* test方法详细说明的第二行
*
* @param a firstnum
* @param b lastnum
* @exception java.lang.ArithmeticException throw when b is 0
* @return 返回值为a/b
*/
public int test(int a,int b) throws java.lang.ArithmeticException{
return a/b;
}
*注意:写文档注释的时候应该注意正确的匹配参数,javadoc在一定程度上不会检查我们写的文档注释,如果写错误可能会造成一些困惑
javadoc命令
用法:javadoc [options] [packagenames] [sourcefiles]
选项:
-public 仅显示 public 类和成员
-protected 显示 protected/public 类和成员 (缺省)
-package 显示 package/protected/public 类和成员
-private 显示所有类和成员
-d <directory> 输出文件的目标目录
-version 包含 @version 段
-author 包含 @author 段
-splitindex 将索引分为每个字母对应一 个文件
-windowtitle <text> 文档的浏览器窗口标题
javadoc可以给定包列表进行编译,如:javadoc xcg xcg.test
也可以给出源文件列表,如:javadoc xcg/test/JavaDocTest.java
以上两种方式的编译结果不同,用包列表生成的文档被框架分成了三个部分:包列表、类列表和类说明
在eclipse或myeclipse中可以使用file->Export->javadoc可以进行手动输出javadoc,需要注意生成的时候可能会出现错误: 编码GBK的不可映射字符,这时就需要在流程的最后一步加上一句话控制字符:-encoding UTF-8 -charset UTF-8,如:
注释规范
1、注释原则:
①注释形式统一
②注释内容准确简单
2、注释条件:
①基本注释(必须加):类、接口的注释、构造函数的注释、方法的注释、全局变量的注释、字段/属性的注释
②特殊必须加的注释:典型算法、代码不清晰易懂时加注释、修改代码时需要加注释、在循环分支需要加注释、为他人提供的接口等信息必须加注释。
JAVADOC注释详解相关推荐
- Java代码中的注释详解
2019独角兽企业重金招聘Python工程师标准>>> java注释详解 声明:本文系JavaEye网站发布的原创博客文章,未经作者书面许可,严禁任何网站转载本文,否则必将追究法律责 ...
- JScript中的条件注释详解(转载自网络)
JScript中的条件注释详解-转载 这篇文章主要介绍了JScript中的条件注释详解,本文讲解了@cc_on.@if.@set.@_win32.@_win16.@_mac等条件注释语句及可用于条件编 ...
- 史上最详细的Pytorch版yolov3代码中文注释详解(四)
史上最详细的Pytorch版yolov3代码中文注释详解(一):https://blog.csdn.net/qq_34199326/article/details/84072505 史上最详细的Pyt ...
- Java注释详解-Java文档注释生成Java API文档
Java文档注释是一种功能强大的注释形式,如果在你所编写的程序中规范的添加文档注释,那你就可以生成一份系统正规的API文档.Java文档注释 /**文档注释内容*/,注意区分多行注释/*多行注释*/. ...
- java注释详解--javadoc注释
一. Java注释分类 // 注释一行 /* ...... */ 注释若干行 /** ...... */ 注释若干行,并写入 javadoc 文档 通常这种注释的多行写法如下: /** * ...
- JSP注释(多种注释详解)
JSP语法缺少不了注释声明,注释是为了能让他人看懂代码. 在 JSP 页面中可以使用多种注释,如 HTML 中的注释.Java 中的注释和在严格意义上说属于 JSP 页面自己的注释--带有 JSP 表 ...
- Java程序中Doc(文档)注释详解
许多人写代码时总不喜欢写注释,每个程序员如此,嘿嘿,我也一样 不过,话说回来,该写还是要写哦!没人会喜欢一个不写注释的程序员,当然,也没有一个喜欢写注释的程序员,今天,我们就来说说Java注释之一-- ...
- java文档注释详解
https://blog.csdn.net/houhj168/article/details/41146415 对于Java语言,最体贴的一项设计就是它并没有打算让人们为了写程序而写程序--人们也需要 ...
- 单片机程序100-300例(付注释详解)
最近两天,写了一篇将近7000字的文章. 不出意外的话,下周一文章内容会在内部学员群里直播. 所以,导致这两天没更文,日更太难了- 今天给粉丝们搞点F利. 就是单片机程序的一些例子,个人认为对于初学者 ...
最新文章
- 「图像分割模型」编解码结构SegNet
- OpenStack开源精神-让企业做到真正自主可控
- python怎么导入视频-Python读取视频的两种方法(imageio和cv2)
- weblogic9修改线程数设置
- php怎么关闭oracle连接,PHP 连接 Oracle
- 【WEB2.0】 网页调用QQ聊天(PC+M站)
- RabbitMQ消息队列入门篇(环境配置+Java实例+基础概念)
- 2022年10款好用免费数据恢复软件分享
- 二元线性方程组与二阶行列式
- 在CheckiO上熟悉编程
- 用java画人物_如何画不同人物的视角?该怎么画?
- matlab的独立样本t检验,独立双样本检验的Matlab实现
- 生产排程系统_APS生产排程系统应用-缩短产品生产周期
- JspWriter与PrintWriter(转)
- 电口以太网物理层一致性测试原理与过程
- 第二届华东架构师大会成功召开
- Linux系统 QT+Faac实时音频采集编码(QT音频采集篇)
- mmap和shmget的区别
- 【蓝桥杯真题练习】STEMA科技素养练习题库 练习版004 持续更新中~
- 2020年最新移动CRM免费下载
热门文章
- html5自学总结及分析,HTML学习记录和总结
- 计算机控制电梯报告总结,电梯控制系统论文
- 数学科学与计算机技术,数学科学与计算技术学院
- linux禁用usb的命令,禁用linux中的usb端口
- 利用 Python 爬取了 37483 条上海二手房信息,我得出的结论是?
- 苹果是怎么吃到的?——职业规划,从了解自己开始
- Task01:数据载入及初步观察
- 机器学习实战:基于Scikit-Learn.Keras和TensorFlow(原书第2版) 奥雷利安·杰龙——环境搭建anaconda
- 附件上传在IE中的问题
- PDF如何翻译成中文?三种方法教你怎样翻译PDF上的文字