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 标签,用于显示“原始样子”的。
*/
三、一个例子
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:
MYSQL问题解决
1. MySQL错误日志里出现: 140331 10:08:18 [ERROR] Error reading master configuration 140331 10:08:18 [ERROR] ...
关于java学习中的一些易错点(基础篇)
由JVM来负责Java程序在该系统中的运行,不同的操作系统需要安装不同的JVM,这样Java程序只需要跟JVM打交道,底层的操作由JVM去执行. JRE(Java Runtime Environmen ...
java文档注释报错,java文档注释主要使用方法相关推荐
- azkaban 与 java任务_azkaban任务报错java.lang.RuntimeException: The root scratch dir: /tmp/hive...
azkaban运行任务的时候失败报错如下: 23-03-2016 08:16:14 CST analyzer-kafka2hdfs_new ERROR - Exception in thread &q ...
- VS CODE JSON添加注释报错 为JSON添加注释
问题描述 在json文件中添加注释后,大面积报错. 解决方案 1.选择JSON 2.选择JSON with Comments后,错误消失
- java远程执行命令报错java.io.IOException: Cannot run program “ifconfig“: error=2, No such file or directory
直接执行ifconfig没问题,但是在java代码里远程执行ifconfig就找不到命令. session = conn.openSession(); session.execCommand(cmd) ...
- java格式话时间报错java cannot format given object as a date
1.例子: String MonthYear = null; SimpleDateFormat simpleDateFormat = new SimpleDateFormat("mm/yyy ...
- hadoop报错 java home_hadoop的常见报错日志以及解决方案
1. WARN util.NativeCodeLoader: Unable to load native-hadoop library for your platform... using built ...
- java调用oracle过程,JAVA调用ORACLE存储过程报错
当前位置:我的异常网» Java Web开发 » JAVA调用ORACLE存储过程报错 JAVA调用ORACLE存储过程报错 www.myexceptions.net 网友分享于:2015-07-1 ...
- 【错误记录】IntelliJ IDEA 中 Java 代码中的中文注释报错 ( Menu / File / Settings / Editor / File Encodings 中修改工程编码 )
文章目录 一.报错信息 二.解决方案 一.报错信息 在 IntelliJ IDEA 中 , 出现中文注释报错 ; Y:\002_WorkSpace\003_IDEA\Groovy_Demo\src\m ...
- java使用cmd编译中文时错误,解决Notepad++编写的Java程序在cmd窗口编译时中文注释报错问题...
解决Notepad++编写的Java程序在cmd窗口编译时中文注释报错问题 解决Notepad++编写的Java程序在cmd窗口编译时中文注释报错问题 在刚开始学习Java的过程中,考虑到记事本应用没 ...
- 关于Swagger报错java.lang.NumberFormatException: For input string: 的总结
关于Swagger报错java.lang.NumberFormatException: For input string: ""的总结 1 为什么会报错? 2 如何排错? 3 哪种 ...
最新文章
- Linux下的C#连接Mysql数据库
- python学习心得--编码格式篇
- Linq to Sql : 动态构造Expression进行动态查询
- 在C#代码中应用Log4Net 中配置文件的解释
- Cannot convert type ‘ASP.login_aspx’ to ‘System.Web.UI.WebControls.Login’的解决方法
- 渗透测试入门DVWA 教程1:环境搭建
- 正则邮箱_自己写一个通用的邮箱正则表达式
- python中如何保存文件_如何在python中处理后保存文件?
- go 基准测试 找不到函数_初学TDD:测试也能推动开发啦!
- Java基础学习总结(111)——Java虚拟机JVM总结大全
- 关于连接查询主要是左右连接查询中,where和on的区别
- 机器学习笔记(二十):逻辑回归(2)
- ai人工智能最新相关消息_我如何了解最新的AI研究
- memset函数的使用
- 九款实用的在线画图工具(那些可以替代Visio的应用)
- 面向后端的前端技术分享
- w ndows安装程序无法将,windows安装程序无法将windows配置在硬件上运行
- shader篇-单张纹理
- 三季度国内光伏市场需求仍将强劲
- html 制作魔方源代码,CSS3 3d环境实现立体 魔方效果代码