Java基础——注释

在开发中注释是必不可少的,帮助我们更好的标记阅读代码,下面介绍几种常用的注释方式。

一、注释种类

1. 单行注释

使用//一行代码来进行注释,只能注释一行内容

2. 多行注释

使用斜杠+星号的方式 /*注释多行代码*/,注释多行代码

3. 文档注释

使用/**文档注释内容*/ 来注释文档内容,一般文档注释用于类、方法、成员变量上

二、JavaDoc

Javadoc 是 Sun 公司提供的一种工具,通过JavaDoc我们可以生成一个源码对应的帮助文档。

1. 常见标签

JavaDoc工具定义了一些识别注释标签,常用的标签如下:

  • @author:标识一个类的作者,一般用于类注释
  • @exception可能抛出异常的说明,一般用于方法注释
  • @param:说明一个方法的参数,一般用于方法注释
  • @return:说明返回值类型,一般用于方法注释,不能出现再构造方法中
  • @throws:和 @exception 标签一样
  • @version :指定类的版本,一般用于类注释

2. 用法命令

通过javadoc -help命令我们可以查看用法帮助

3.类的javaDoc注释

4.方法的JavaDoc注释

4.变量的JavaDoc注释

相关推荐
Java练习两年半5 分钟前
互联网大厂 Java 求职面试:技术栈与微服务深度解析
java·微服务·面试·技术栈
Seven9711 分钟前
类字节码:揭开Java虚拟机运行机制的神秘面纱
java
chilavert31813 分钟前
程序员面试经典问题解答:java篇-2
开发语言·python
senijusene15 分钟前
TCP并发服务器:poll和epoll的多路复用
开发语言·php
浅碎时光80731 分钟前
Qt (按钮/显示/输入/容器类控件 布局管理器)
开发语言·qt
lang2015092832 分钟前
从零开始掌握 Logback:Java 日志框架的“Hello World”实战指南
java·单元测试·logback
bubiyoushang88841 分钟前
OFDM系统信道估计MATLAB实现(LS、MMSE、DCT、LRMMSE方法)
开发语言·网络·matlab
lang2015092841 分钟前
Logback 过滤器深度指南:从“三值逻辑”到高性能拦截
java·网络·logback
Felven1 小时前
C. Dora and Search
c语言·开发语言
左左右右左右摇晃1 小时前
Java 对象:创建方式与内存回收机制
java·笔记