程序员经验分享-hwhale

java的三种代码注释方式

2023-05-16

1.注释的作用

注释是对程序语言的说明，有助于开发者之间的交流，方便理解和维护程序。注释不是编程语句，不会被编译器执行。一些代码量少较少的程序，我们加不加注释对我们的理解和修改代码没有太大影响；如果是淘宝；抖音等那种中大型程序，没有了代码注释，对于日后程序运行维护将是很大困难。我们可以在平时编码过程中养成规范代码注释习惯，也是我们成为优秀程序员的原因

2.java中的注释分类

Java中的注释分为以下三种：单行注释；多行注释；文档注释

1.单行注释

java代码中使用双斜杠单行注释//，一般单行注释，注释少量代码或者说明内容 ，格式为：

// 单行注释

2.多行注释

java代码中使用多行注释/* */，一般使用多行注释大量的代码或者说明内容 ，格式为：

/*

多行注释

多行注释

*/

3.文档注释

使用文档注释/** */，文档注释一般用于对类和方法进行功能说明 ，说明类的编写时间和作者以及方法作用参数和返回值

3.1类上的注释

/**
* 类上的文档注释
* @author 张三
* @version  1.10.0
*/

3.2方法上的注释

/** 
* 方法前的文档注释
* @param 
* @return 
* @throws  
*/
标签描述
@author标识一个类的作者
@version版本号
@since当前文件使用jdk版本
@return说明方法返回值类型
@param说明一个方法的参数
@throws抛出的异常
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)

Java

三种代码注释方式

java的三种代码注释方式 的相关文章

  • 在 Java 中捕获（捕获）窗口中的鼠标光标

    我正在寻找一种方法 在鼠标进入窗口后捕获或捕获该窗口中的鼠标 就像鼠标被捕获在虚拟机窗口中一样 直到用户按 CTRL ALT DEL 或以其他方式释放鼠标 我如何在 Java 中实现这一点 全屏显示不是一个选择 EDIT 这里有一些 SSC

  • Android：java.lang.OutOfMemoryError：

    我在 Android 上开发了一个使用大量图像的应用程序 可绘制文件夹中有很多图像 比如说超过 100 张 我正在开发图像动画应用程序 我使用 imageview 来显示 GIF 图像 我使用了将 gif 图像分割成多个 PNG 格式图像的

  • JAVA 中的 Composer 相当于什么？ [关闭]

    Closed 这个问题不符合堆栈溢出指南 help closed questions 目前不接受答案 我目前从 PHP 转向 java 有没有类似的工具composer https getcomposer org 在 PHP 中用于 JAV

  • 垂直 ViewPager 中的动画

    我需要垂直制作这个动画ViewPager https www youtube com watch v wuE 4jjnp3g https www youtube com watch v wuE 4jjnp3g 这是我到目前为止所尝试的 vi

  • 获取Android库中的上下文

    我正在编写一个 Android 应用程序 它的一些功能封装在内部库中 但是 要使此功能发挥作用 库需要一个应用程序上下文的实例 为图书馆提供这种上下文的最佳方式是什么 我看到了一些选择 但没有一个有吸引力 Have my library c

  • Selenium 和 TestNG 同时使用“dependsOn”和“priority =”问题

    我正在努力在 GUI 自动化测试中实现更好的工作流程控制 我首先从dependsOn开始 但很快发现缺点是如果一个测试失败 则套件的整个其余部分都不会运行 所以我改用 priority 但看到了意外的行为 一个例子 Test priorit

  • 使用全局变量从内部函数获取空字符串

    请帮助我解决一些小问题 我确信你能做到 D 我试图在 firestore 文档 user cases information 上设置一个字段 其中包含一个字段 case number 首先我声明这个全局变量 private String c

  • Java Junit 测试 HTTP POST 请求

    我需要测试以下方法而不改变方法本身 该方法向服务器发出 POST 方法 但我需要制作一个独立于服务器的测试用例 在将其重定向到本地文件之前 我测试了类似的方法 但为此我将协议指定为文件 主机名指定为 localhost 端口指定为 1 我的

  • 使用 kryo 注册课程的策略

    我最近发现了 kryonet 库 它非常棒并且非常适合我的需求 然而 我遇到的一个问题是制定一种好的策略来注册所有可以转移的类 我知道我可以在每个对象中编写一个静态方法 该方法将返回它使用的所有类的列表 但我真的不想这样做 为了我自己的时间

  • java项目中无法加载类“org.slf4j.impl.StaticLoggerBinder”错误？ [复制]

    这个问题在这里已经有答案了 我越来越Failed to load class org slf4j impl StaticLoggerBinder 错误 我想将记录器写入文件 所以我使用了 log4j jar 并使用 apache tomca

  • 使用 Jena 查询维基数据

    目前 Wikidata 有一个 SPARQL 端点 https query wikidata org https query wikidata org 我想使用 Jena 3 0 1 查询此网站 我使用以下代码 但收到错误消息 端点返回的

  • Java 中如何验证字符串的格式是否正确

    我目前正在用 Java 编写一个验证方法来检查字符串是否是要更改为日期的几种不同格式之一 我希望它接受的格式如下 MM DD YY M DD YY MM D YY 和 M D YY 我正在测试第一种格式 每次它都告诉我它无效 即使我输入了有

  • 如何在Netbeans中设置JList的ListModel？

    我在 Netbeans IDE 的帮助下设计了一个 Swing GUI 该 GUI 包含一个 JList 默认情况下 它使用 QAbstractListModel 将其作为 JList 构造函数中的参数传递以创建该 JList 我想在 Ne

  • Time.valueOf 方法返回错误值

    我使用 Time valueOf 方法将字符串 09 00 00 转换为 Time 对象 如下所示 Time valueOf LocalTime parse 09 00 00 当我调用 getTime 来显示我得到的值时 28800000

  • 使用 Guava Ordering 对对象列表进行多条件排序

    我有一个类无法实现可比较 但需要根据 2 个字段进行排序 我怎样才能用番石榴实现这一目标 假设班级是 class X String stringValue java util Date dateValue 我有一个清单 List

  • Java HashSet 是线程安全的只读吗？

    如果我通过 Collections unmodifyingSet 运行 HashSet 实例后 它是线程安全的吗 我问这个是因为 Set 文档声明它不是 但我只是执行读取操作 来自 Javadoc 请注意 此实现不是同步的 如果多个线程同时

  • Hibernate 标准接受 %% 值

    我正在使用下面的 Hibernate 代码来过滤workFlowName crt add Restrictions like workFlowName workFlow MatchMode ANYWHERE crt is the crite

  • 获取 Future 对象的进度的能力

    参考 java util concurrent 包和 Future 接口 我注意到 除非我弄错了 只有 SwingWorker 实现类才能启动冗长的任务并能够查询进度 这就引出了以下问题 有没有办法在非 GUI 非 Swing 应用程序 映

  • java.lang.UnsatisfiedLinkError - android studio gradle 中的 NDK？

    文件夹结构 app main java jni Android mk Application mk hello jni c res 在构建 gradle apply plugin com android application androi

  • 检查按钮是否可用？如果没有，请等待 5 秒钟，然后再次检查？

    基本上我想看看此刻是否可以单击按钮 如果没有我想再试一次 所以我需要某种 goto 函数来返回到代码的前一行 尽管我怀疑我写得非常糟糕 但它本来可以做得更容易 try driver findElement By xpath button i

随机推荐

  • Linux/CenterOS设置免密登陆

    systemctl start sshd service 开启ssh服务 systemctl stop firewalld 关闭防火墙 ssh无密码登录 但是每次输入密码登录十分麻烦 xff0c 有没有一种方式可以让服务器能够确定我的身份

  • python的range函数用法和实例

    目录 1 range函数的语法及用法 xff08 1 xff09 语法 语法一 xff1a range end 语法二 xff1a range begin end step xff08 2 xff09 用法 xff1a 用于获取迭代的对象

  • python的max、min函数的用法及实例

    目录 1 max函数和min函数的语法和用法 xff08 1 xff09 语法 max函数 xff1a max iterable default 61 obj key 61 func max arg1 arg2 args key 61 fu

  • python如何实现字符串替代replace函数的用法和实例

    目录 1 replace函数的语法和用法 xff08 1 xff09 语法 xff1a str replace old str new str max num xff08 2 xff09 用法 xff1a 将指定字符串替代为目标字符串 2

  • python的strip、lstrip、rstrip函数的用法和实例

    目录 1 strip函数的用法和实例 xff08 1 xff09 语法和用法 语法 xff1a str strip string 用法 xff1a 替代字符串两边某指定字符 xff08 2 xff09 实例 简单的用法 与if函数结合使用

  • python的list列表的增加方法运用

    目录 1 append方法的用法和实例 xff08 1 xff09 语法 xff1a list append object xff08 2 xff09 用法 xff1a 可以在原有列表尾部插入目标的值 xff08 3 xff09 实例 简单

  • python的list列表的删除方法运用

    目录 1 pop方法的用法和实例 1 语法 list pop index

  • python列表list的index方法的用法和实例

    目录 1 index方法的用法和实例 xff08 1 xff09 语法 xff1a list index xff08 object start end xff09 xff08 2 xff09 用法 xff1a 从列表中获取指定索引元素的第一

  • python的列表list排序方法——sort、reverse用法及实例

    目录 1 sort方法的用法和实例 xff08 1 xff09 语法 xff1a list sort key reverse xff08 2 xff09 用法 用于对列表进行排序 xff08 3 xff09 实例 简单的用法实例 与lamb

  • python数据类型之间的互相转换

    目录 1 将元组转为列表 xff08 1 xff09 语法 xff1a list tuple xff08 2 xff09 实例 简单的用法实例 与for函数 if函数 split函数结合使用 2 将列表转为元组 xff08 1 xff09

  • excel的frequency函数的用法和实例

    目录 1 语法和用法 xff08 1 xff09 语法 xff1a frequency data array bins array xff08 2 xff09 用法 xff1a 用于统计指定分组区间的频率 xff0c 以已裂垂直数组返回一组

  • Linux系统下通过命令行获取bios等相关信息

    查看服务器型号 xff1a dmidecode grep 39 Product Name 39 查看主板的序列号 xff1a dmidecode grep 39 Serial Number dmidecode t 1 查看序列号及品牌型号

  • python如何获取时间和格式化时间和日期 ？

    目录 1 time time xff08 1 xff09 用法 xff1a 用于获取当前时间戳 xff08 2 xff09 实例 2 time localtime xff08 1 xff09 语法 xff1a time localtime

  • python的datetime模块常用的语法和实例

    目录 1 datetime类获取日期时间 xff08 1 xff09 datetime datetime now 用法 xff1a 获取系统当前时间 xff08 2 xff09 datetime datetime today 用法 xff1

  • python的自定义函数的用法和实例

    目录 1 自定义函数的语法和用法 xff08 1 xff09 引入 xff08 2 xff09 语法 xff08 3 xff09 用法 xff1a 用于自定义目标函数语法 xff08 4 xff09 调用函数 语法 解释 2 实例 xff0

  • python的字典dict实例

    1 获取目标字典 xff0c 将字典中的字键和值调换 xff0c 读取名字 dict 61 39 Zara 39 39 Name 39 7 39 Age 39 39 First 39 39 Class 39 dict items 以列表返回

  • python利用read()、readline()、readlines()读取文件

    目录 1 语法和用法 2 实例 1 语法和用法 with open file mode 61 39 r 39 encoding 61 None as f 读取所有文本 data1 61 f read 读取第一行数据 data2 61 f r

  • python的panda库读写文件

    目录 1 读取excel文件 xff08 1 xff09 语法 xff08 2 xff09 实例 2 读取cvs文件 xff08 1 xff09 语法 xff08 2 xff09 实例 3 读取txt文件 xff08 1 xff09 语法

  • frankmocap

    1 配置和报错 1 1 模块缺失 ModuleNotFoundError No module named detectors body pose estimator pose2d models 下载问题 xff0c 下载完之后该文件夹下面的

  • java的三种代码注释方式

    1 注释的作用 注释是对程序语言的说明 xff0c 有助于开发者之间的交流 xff0c 方便理解和维护程序 注释不是编程语句 xff0c 不会被编译器执行 一些代码量少较少的程序 xff0c 我们加不加注释对我们的理解和修改代码没有太大影响

热门标签