java文档注释报错,java文档注释主要使用方法「建议收藏」

一、java包含哪些注释

1.//用于单行注释。

2./*…*/用于多行注释，从/*开始，到*/结束，不能嵌套。

3./**…*/则是为支持jdk工具javadoc.exe而特有的注释语句。这个也就是我们所知的文档注释

在命名控制台:使用命令行在目标文件所在目录输入javadoc +文件名.java。

二、文档注释的关键名词

/**

标记 用于 作用

* @author 类或方法 一般用于描述开放者

* @version 类 版本说明

* @see 对类、属性、方法的说明 　　　　　　　　　　 参考转向，也就是相关主题

* @param 方法 对方法参数的说明

* @throws 方法 对异常的说明

* @return 方法 对返回值的说明

* {@value} 方法，类 、属性 可以用于生成被标记的常量字段的值。

* {@inheritDoc} 方法、类 可以集成上一个文档的注释

* {@link} 类、方法 链接标签

* {@linkplain} 类、方法 链接标签、与上一个标签唯一的不同就是因为字体不同，如果 label 是个纯文本，那就使用 linkplain

* @since 类、方法 表达的是被标记元素是哪个发布版本引入的

* @exception 方法 跟@throws的用法相同

* @serialData

*

          方法、类                                    没错，这就是那个 HTML 标签，用于显示“原始样子”的。

Jetbrains全家桶1年46，售后保障稳定

*/

三、一个例子

public void aa(){

}

/**一般这几个注解够开放使用了

* @author mingge

* @since 1.0

* @see #aa() 查看aa方法

* @param a 参数a

* @return 返回值描述

* @throws 异常说明

*/

public int test(int a) throws Exception{

return a;

}

我觉得很多细节还需要学习，天天学习，天天进步!

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

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

Java – 34 Java 文档注释

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

Java-Runoob-高级教程：Java 文档注释

ylbtech-Java-Runoob-高级教程:Java 文档注释 1.返回顶部 1. Java 文档注释 Java 支持三种注释方式.前两种分别是 // 和 /* */,第三种被称作说明注释,它以 …

Java 学习(20)：Java Applet 基础 & Java 文档注释

— Java Applet 基础 — Java 文档注释 Java Applet 基础 Applet 是一种 Java 程序.它一般运行在支持 Java 的 Web 浏览器内.因为它有完整的 Ja …

java文档注释规范(一)

https://blog.csdn.net/huangsiqian/article/details/82725214 Javadoc工具将从四种不同类型的“源”文件生成输出文档:Java语言类的源文件 …

如何为我们的程序编写开发文档——Java文档注释

Java文档注释是用于生成Java API文档的注释,通过在程序中的类.属性.方法部分加上注释,就可以用javadoc命令生成漂亮的API文档,是程序员进阶的必备技能. 注意,文档注释只说明紧跟其后的 …

java文档注释–javadoc的用法

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

JAVA文档注释标签

1 常用Java注释标签(Java comment tags) @author  作者 @param  输入参数的名称  说明 @return 输出参数说明 @since JDK版本 @version …

随机推荐

java编译做了哪些事？

Javac编译器,主要做了如下的事情:1.解析与填充符号表:    2.注解处理器:    3.语义分析与字节码生成:        3.1.标注检查        3.2.数据及控制流分析      …

InnoDB关键特性之insert buffer

insert buffer 是InnoDB存储引擎所独有的功能.通过insert buffer,InnoDB存储引擎可以大幅度提高数据库中非唯一辅助索引的插入性能. 数据库对于自增主键值的插入是顺序的 …

vue2入坑随记(一)

都说Vue2简单,上手容易,但小马过河,自己试了才晓得,除了ES6语法和webpack的配置让你感到陌生,重要的是思路的变换,以前随便拿全局变量和修改dom的锤子不能用了,变换到关注数据本身.vue的 …

[code segments] OpenCV3.0 SVM with C++ interface

talk is cheap, show you the code: /***************************************************************** …

js数字串传参时变科学计数法

例1:οnclick=channel_info_listFt(\”‘+val.gid+’\”,’+val.deviceIdOwner+’,’+val.gname+’) 当长度过长的 …

Mac环境下 elasticsearch-6.0.1 和 elasticsearch-head 完整安装过程

安装步骤: 安装java jdk 安装elasticsearch-6.0.1 及中文分词 anslysis-ik-6.0.1 安装elasticsearch-head 下载jdk https://w …

SQLI DUMB SERIES-16

(1)无论怎么输入,都没有回显,但当输入 admin”)#时,显示登录成功.若通过其他方法获取数据库的用户名,可通过这个方法登录成功. (2)获取其他信息可用考虑时间延迟注入.方法同15.

CSS实现移动端横向滑动

html: