千锋教育-做有情怀、有良心、有品质的职业教育机构

手机站
千锋教育

千锋学习站 | 随时随地免费学

千锋教育

扫一扫进入千锋手机站

领取全套视频
千锋教育

关注千锋学习站小程序
随时随地免费学习课程

当前位置:首页  >  技术干货  > java注释:单行、多行和文档注释

java注释:单行、多行和文档注释

来源:千锋教育
发布人:yyy
时间: 2023-06-09 12:59:00 1686286740

  在 Java 中,有三种常用的注释形式:单行注释、多行注释和文档注释。

  1. 单行注释:以双斜线 (`//`) 开始,用于在一行内注释单个语句或说明代码的含义。

java
// 这是一个单行注释
int x = 5; // 初始化变量 x

   2. 多行注释:以斜线加星号 (`/*`) 开始,以星号加斜线 (`*/`) 结束,用于注释多行代码或较长的说明。 

java
/*
这是一个多行注释
它可以跨越多行,用于注释多个语句或一段代码
*/
int x = 5;
int y = 10;

   3. 文档注释:以斜线加星号加两个星号 (`/**`) 开始,以星号加斜线 (`*/`) 结束,用于为类、方法、字段等编写详细的文档说明。文档注释可以通过工具生成文档,如使用 `javadoc` 工具生成 API 文档。

java
/**
* 这是一个文档注释
* 用于对类、方法、字段等进行详细的文档说明
*/
public class MyClass {
/**
* 这是一个方法的文档注释
* @param x 参数 x
* @param y 参数 y
* @return 返回结果
*/
public int add(int x, int y) {
return x + y;
}
}

   文档注释使用特殊的标记(`@`)和标记名称,例如 `@param` 用于描述方法的参数,`@return` 用于描述方法的返回值。通过在代码中使用文档注释,可以为其他开发人员提供清晰的代码文档和使用说明。

  注意,注释是用于解释代码和提供文档,不会被编译器编译和执行。注释不会对程序的运行产生任何影响,仅供开发人员阅读和理解代码。

tags: java注释
声明:本站稿件版权均属千锋教育所有,未经许可不得擅自转载。
10年以上业内强师集结,手把手带你蜕变精英
请您保持通讯畅通,专属学习老师24小时内将与您1V1沟通
免费领取
今日已有369人领取成功
刘同学 138****2860 刚刚成功领取
王同学 131****2015 刚刚成功领取
张同学 133****4652 刚刚成功领取
李同学 135****8607 刚刚成功领取
杨同学 132****5667 刚刚成功领取
岳同学 134****6652 刚刚成功领取
梁同学 157****2950 刚刚成功领取
刘同学 189****1015 刚刚成功领取
张同学 155****4678 刚刚成功领取
邹同学 139****2907 刚刚成功领取
董同学 138****2867 刚刚成功领取
周同学 136****3602 刚刚成功领取
相关推荐HOT