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注释

相关推荐
一切尽在,你来19 小时前
C++ 零基础教程 - 第 5 讲 变量和数据类型
开发语言·c++
serve the people19 小时前
python环境搭建 (六) Makefile 简单使用方法
java·服务器·python
重生之后端学习19 小时前
146. LRU 缓存
java·数据结构·算法·leetcode·职场和发展
萧曵 丶19 小时前
懒加载单例模式中DCL方式和原理解析
java·开发语言·单例模式·dcl
℡枫叶℡19 小时前
C# - 指定友元程序集
开发语言·c#·友元程序集
回忆是昨天里的海19 小时前
k8s部署的微服务动态扩容
java·运维·kubernetes
萧曵 丶19 小时前
单例模式 7 种实现方式对比表
java·单例模式
阿猿收手吧!19 小时前
【C++】constexpr动态内存与双模式革命
开发语言·c++
lang2015092819 小时前
Tomcat Maven插件全解析:开发部署一体化
java·tomcat·maven
JHC_binge19 小时前
国内Ubuntu 22.04 LTS安装Milvus向量数据库
java·linux·ubuntu