3.9 使用Java的文档注释

2023-11-12

 

Java支持三种形式的注释。前两种是// 和/* */。第三种方式被称为文档注释。它以“/**”开始,以“*”标志结束。文档注释提供将程序信息嵌入程序的功能。开发者可以使用javadoc工具将信息取出,然后转换为HTML文件。文档注释提供了编写程序文档的便利方式。javadoc工具生成的文档几乎人人都看过,因为Sun的Java API文档库就是这么生成的。

javadoc标记

javadoc实用程序识别下列标记:

Tag标记

意义

@author

确定类的作者

@deprecated

指示反对使用这个类或成员

{@docRoot}

指定当前文档的根目录路径 (Java 2的1.3版新增)

@exception

确定一个方法引发的异常

{@link}

插入对另一个主题的内部链接

@param

为方法的参数提供文档

@return

为方法的返回值提供文档

@see

指定对另一个主题的链接

@serial

为默认的可序列化字段提供文档

@serialData

为writeObject( )或者writeExternal( )方法编写的数据提供文档

@serialField

为ObjectStreamField组件提供文档

@since

当引入一个特定改变时,声明发布版本

@throws

与&

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

3.9 使用Java的文档注释 的相关文章

随机推荐

  • 【2022年第十三届蓝桥杯省赛个人题解】

    A 九进制转十进制 5分 题目描述 九进制正整数 2022 9 2022 9 2022 9 转换成十进制等于多少 AC代码 include
  • 【数据结构】HashMap

    文章目录 参数 DEFAULT INITIAL CAPACITY MAXIMUM CAPACITY loadFactor initialCapacity threshold 方法 tableSizeFor hash 参数 DEFAULT I
  • Python+selenium的web自动化—PageObject模式解析及案例

    一 PO模式 Page Object 简称PO 模式 是Selenium实战中最为流行 并且是自动化测试中最为熟悉和推崇的一种设计模式 在设计自动化测试时 把页面元素和元素的操作方法按照页面抽象出来 分离成一定的对象 然后再进行组织 做we
  • Qt 绘制炫彩时钟

    录制 2022 09 15 09 44 58 720 思路 1 使用定时器 每秒给 秒值 增加 1 当 秒值 等于 60 时 给 分值 增加1 当分值为60时 给 时值 加1 2 绘制界面时 可以用信号槽触发 也可以调用函数触发 我这里用的
  • 高中辍学后,我转行做了程序员

    大家好 我是黑洋葱 非常普通的一个人 没有太多的故事 可以拿得出手的经历大概就是我从高中辍学后通过自考顺利拿到本科证书 以及通过自学成功转行成IT行业的程序员这一段 今天写下这段完全改变了我人生轨迹的经历 同时也稍微整理了 转行程序员 的学
  • 新手如何使用IntelliJ IDEA创建Java项目

    前提 已安装好IntelliJ IDEA 已安装好jdk 已配置好环境变量 后续会继续推出IntelliJ IDEA的安装 jdk的安装和环境变量的配置 1 第一步打开IntelliJ IDEA 这里默认已经安装好IntelliJ IDEA
  • Elasticsearch 2.x版本往5.x版本迁移数据

    Elasticsearch 2 x版本往5 x版本迁移数据 迁移前准备 1 String类型 2 x版本 跟 5 x版本有一个比较大的改动就是ES的基本类型string字段 5 x版本中使用text keyword字段替代了2 x版本的st
  • Eos离线签名PHP代码

    EOS区块链的钱包服务器Keosd 提供了sign transaction开发接口 允许开发者进行交易签名 但是 如果我们希望自己管理密钥而不是交给keosd管理 应该如何在PHP代码中实现交易的离线签名功能 答案是使用 EosTool 这
  • jq+swiper 实现今日头条App的选项卡效果

  • 新版iTunes 不能安装 ipa 包的五种解决办法

    前言 1 新版iTunes指的是 V12 7 2 新版iTunes界面无应用按钮 即无法安装ipa包 五种方法 1 使用iTools 2 使用低版本的iTunes 1 降低iTunes版本的方法 http bbs feng com read
  • C语言基础入门详解二

    前些天发现了一个蛮有意思的人工智能学习网站 8个字形容一下 通俗易懂 风趣幽默 感觉非常有意思 忍不住分享一下给大家 点击跳转到教程 一 C语言多级指针入门 include
  • 1.5 条件生成对抗网络(CGAN)

    1 什么是CGAN 在CGAN训练期间 生成器学习为训练数据集中的每个标签生成逼真的样本 而鉴别器则学习区分真的样本 标签对与假的样本 标签对 只学习接受真实且样本 标签匹配正确的对 拒绝不匹配的对和样本为假的对 2 生成器 条件标签称为y
  • 深入理解Android相机体系结构之十一

    手机相机的未来与发展 Android相机发展至今 通过开发者对框架的不断优化 算法人员对图像处理算法的不断提升 硬件工程师对硬件性能地不断调教 换来了在某些领域完全可以媲美专业相机的成像效果 这些成绩是有目共睹的 但是我们不能仅仅着眼于过去
  • 开源知识库平台Raneto

    什么是 Raneto Raneto 是一个开源知识库平台 它使用静态 Markdown 文件来支持您的知识库 官方提供了 doc demo 网站 即是帮助文档 也是个 demo 地址 https docs raneto com 准备 项目使
  • 【Yarn】ContainerAllocator Container申请工作机制

    文章目录 1 概述 2 继承体系 3 serviceStart 4 RMContainerAllocator 4 1 构造方法 4 1 1 createAssignedRequests 4 2 serviceInit 4 3 service
  • python 十大经典排序算法

    排序算法可以分为内部排序和外部排序 内部排序是数据记录在内存中进行排序 而外部排序是因排序的数据很大 一次不能容纳全部的排序记录 在排序过程中需要访问外存 常见的内部排序算法有 插入排序 希尔排序 选择排序 冒泡排序 归并排序 快速排序 堆
  • 利用python基于GBDT算法建立轨道交通客流预测模型,并使用网格搜索法进行参数调优...

    你可以使用Python来建立一个基于GBDT算法的轨道交通客流预测模型 为了得到最佳的预测效果 你可以使用网格搜索法来调整模型的参数 网格搜索法是一种通过对参数的不同取值进行试验来选择最优参数的方法
  • 机器学习笔记Machine Learning 之SVD (Singular Value Decomposition) 奇异值分解

    一 特征值和特征向量 A x x Ax lambda x Ax x A 是一个 n n 矩阵 x 是一个 n 维向量
  • webpack的四大核心概念

    webpack中文文档 https doc webpack china org concepts 一 Entry 入口 1 单个入口 简写 语法 语法 entry string Array
  • 3.9 使用Java的文档注释

    Java支持三种形式的注释 前两种是 和 第三种方式被称为文档注释 它以 开始 以 标志结束 文档注释提供将程序信息嵌入程序的功能 开发者可以使用javadoc工具将信息取出 然后转换为HTML文件 文档注释提供了编写程序文档的便利方式 j