java中文档注释作用_java中文档注释
1常用Java注释标签(Java comment tags)
@author作者
@param输入参数的名称说明
@return输出参数说明
@since JDK版本
@version版本号
@see链接目标
@throws异常
@deprecated解释
@link链接地址
2 Java注释的使用顺序
3简单常见的HTML嵌入
4HTML嵌入注释范例
5参考文档
1常用Java注释标签(Java comment tags)
适用范围:文件、类、方法
(*多个作者使用多个@author标签标识,java doc中显示按输入时间顺序罗列。)
例:* @author Leo. Yao
@param输入参数的名称说明
适用范围:方法
例:* @param str the String用来存放输出信息。
适用范围:方法
例: * @return true
执行成功;
* false
执行失败.
用于标识编译该文件所需要的JDK环境。
适用范围:文件、类
例: * @since JDK1.6
用于标识注释对象的版本号
适用范围:文件、类、方法
例: * @version 1.0
@see链接目标
表示参考。会在java文档中生成一个超链接,链接到参考的类容。使用中的感觉是@see不需要包路径,对我这种懒人比较喜欢,相对{@link }这种既要加大括号,有需要包路径,我还是选择偷懒,当然你要是不介意使用import导入要link的类,那就可以达到@see的效果,所以总体来说,还是选择@see,当然两个在特殊场合下还是用法不一样的
用法:
@see #field
@see #Constructor(Type, Type...)
@see #Constructor(Type id, Type id...)
@see #method(Type, Type,...)
@see #method(Type id, Type, id...)
@see Class
@see Class#field
@see Class#Constructor(Type, Type...)
@see Class#Constructor(Type id, Type id)
@see Class#method(Type, Type,...)
@see Class#method(Type id, Type id,...)
@see package.Class
@see package.Class#field
@see package.Class#Constructor(Type, Type...)
@see package.Class#Constructor(Type id, Type id)
@see package.Class#method(Type, Type,...)
@see package.Class#method(Type id, Type, id)
@see package
标识出方法可能抛出的异常
适用范围:方法
例:* @throws IOException If an input or output exception occurred
标识对象过期
适用范围:文件、类、方法
链接到一个目标,用法类似@see。但常放在注释的解释中形如{@link …}
例:
/**
* @deprecated As of JDK 1.1, replaced by
* {@link #setBounds(int,int,int,int)}
*/
2 Java注释的使用顺序
* @author (classes and interfaces only, required)
* @version (classes and interfaces only, required. See footnote 1)
* @param (methods and constructors only)
* @return (methods only)
* @exception (@throws is a synonym added in Javadoc 1.2)
* @see
* @since
* @serial (or @serialField or @serialData)
* @deprecated (see How and When To Deprecate APIs)
3简单常见的HTML嵌入
用于分段
标签用于表示计算机源代码或者其他机器可以阅读的文本内容。
标签就是为软件代码的编写者设计的。包含在该标签内的文本将用等宽、类似电传打字机样式的字体(Courier)显示出来只应该在表示计算机程序源代码或者其他机器可以阅读的文本内容上使用标签。虽然
标签通常只是把文本变成等宽字体,但它暗示着这段文本是源程序代码。将来的浏览器有可能会加入其他显示效果。例如,程序员的浏览器可能会寻找片段,并执行某些额外的文本格式化处理,如循环和条件判断语句的特殊缩进等。
本文参考:
后边会完善
java中文档注释作用_java中文档注释相关推荐
- java注释类型_Java 8类型注释
java注释类型 Lambda表达式是迄今为止Java 8讨论最多和最受促进的功能.虽然我同意Lambda是一个很大的改进,但我认为其他一些Java 8功能由于Lambda的炒作而有所欠缺. 在这篇文 ...
- java 注解处理器的作用_Java注解处理器
Java中的注解(Annotation)是一个很神奇的东西,特别现在有很多Android库都是使用注解的方式来实现的.一直想详细了解一下其中的原理.很有幸阅读到一篇详细解释编写注解处理器的文章.本文的 ...
- java逻辑层的作用_java三层架构原理与作用小结
三层架构 三层架构(3-tier application) 通常意义上的三层架构就是将整个业务应用划分为:表现层(UI).业务逻辑层(BLL).数据访问层(DAL).区分层次的目的即为了"高 ...
- java类与对象作用_Java类与对象
●类和对象的关系: 一:类是对同一类事物(对象)的抽象,对象实际存在的该类的各种实体. 二:面向对编程的核心:找合适的对象来做合适的事. 三:Java中找到对象: 1):sun自己定义好的类,必须知道 ...
- java 代码块的作用_Java核心(三):代码块的作用
Java中用{ }括起来的代码段就是代码块,他分为如下几种类型 位置 作用 局部代码块 在方法当中使用,作用是控制变量的生命周期. 局部代码块的变量,只能在代码块内部使用,在执行结束后会被Java回收 ...
- java 中gui的作用_java学习中最应该注意的Java GUI用户界面以何为基础
java中的GUI编程(Graphic User Interface,图形用户接口),是在它的笼统窗(Abstract Window Toolkit,AWT)上完成的,java.awt是AWT的东西类 ...
- java统计文件字符数量_Java统计文件注释个数和注释字符数
我把文件一行一行地存入到了动态数组 list中,然后删除list里面的注释和输出语句.其中countNote是算注释个数的,charInNote是算注释的总字符数的.可是最后得到的list存在很多问题 ...
- java daemon线程的作用_JAVA DAEMON线程的理解
java线程分两种:用户线程和daemon线程.daemon线程或进程就是守护线程或者进程,但是java中所说的daemon线程和linux中的daemon是有一点区别的. linux中的daemon ...
- java volatile关键字的作用_java volatile关键字作用及使用场景详解
1. volatile关键字的作用:保证了变量的可见性(visibility).被volatile关键字修饰的变量,如果值发生了变更,其他线程立马可见,避免出现脏读的现象.如以下代码片段,isShut ...
最新文章
- 修改所有列_多人编辑,自动汇总,领导可见所有?用 SeaTable 表格更简单
- 人才招聘丨 清华大学精准医学研究院招聘启事
- React Native 'config.h' file not found
- SQL Server 2000安装指南及数据创建
- Android学习笔记26:图片切换控件ImageSwitcher的使用
- JPEG图片扩展信息读取与改动
- c语言循环字符,字符串 非暴力for循环法(内附C语言代码)
- pandas.plotting
- HDU [1529] || POJ [P1275] Cashier Employment
- css实用技巧之制作优惠券凹槽
- 先手获胜逻辑题_宣布障碍塔挑战赛的获胜者和开源版本
- 项目管理计划Office Project 2013 日常使用
- 粉刷匠计算机音乐,音乐《粉刷匠》
- 前端vue实现图片压缩并且将其转换为jpg格式图片;前端转换图片格式;前端使用js转换图片格式;前端使用canvas将png格式图片转成jpg格式
- Liber 1. 《活着》:人生如逆旅,我亦是行人
- 虚拟贝司拓展音源-Toontrack Acoustic EBX
- Pandas入门超详细教程,看了超简单
- Ubuntu 虚拟机的 wifi 连接图标上有个问号,网络用不了
- 图片加载失败替代文字_替代艺术:为图像编写出色的描述性文字
- 特斯拉Tesla Model 3整体架构解析
热门文章
- 操作符【零基础搞定C语言——10】
- 分析了一下360安全卫士的 HOOK(二)——架构与实现(zt)
- Android之使用TCP和URL协议进行网络编程
- 适合零基础的Java基础入门知识(部分,后续会不断更新)-看后觉得不错,请点赞收藏-咱们一起进步
- 施努卡:机器人视觉案例(工业机器人的案例)
- 罗永浩曝手机发布会猛料/“不限量套餐”将停售?以上为今日内容
- ubuntu 引导项修复
- 用ADB命令写Android自动化测试脚本
- C语言课程设计不会做?其实各种信息管理系统都一样!
- 零点工作室暑假集训(AtCoder--ABC234)