首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

用Java注释代码的最佳方法

在Java中,编写注释的最佳方法是使用//单行注释或者/* */多行注释。

单行注释:

代码语言:java
复制
// 这是一个单行注释
public class MyClass {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}

多行注释:

代码语言:java
复制
/*
这是一个多行注释
这里可以写任意多的行
*/
public class MyClass {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}

在JavaDoc中,可以使用/** */来编写文档注释,这种注释可以为类、方法、变量等提供详细的描述和说明。

文档注释:

代码语言:java
复制
/**
 * 这是一个文档注释
 * 用于描述类、方法或变量的详细信息
 */
public class MyClass {
    /**
     * 这是一个main方法
     * @param args 命令行参数
     */
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}

使用这些注释方法可以帮助提高代码的可读性和可维护性,同时也方便了其他开发者的理解和使用。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

Java方法字段注释详解

一个程序可读性,关键取决于注释。如果一个程序想二次开发,要读懂前面的程序代码,就必须在程序中有大量注释文档,所以对于一个优秀程序员来说,学会在程序中适当地添加注释是非常重要。...@和标记类型之间有时可以空格符分隔,但是不推荐空格符分隔,这样容易出错。 一个类注释创建人、创建时间和描述是不可缺少。下面是一个类注释例子。...{ int value = num1 + num2; return value; } 以上代码 add() 方法中声明了两个形参,并将它们两个和作为返回值返回。...为类构造方法添加注释时,一般声明该方法参数信息,代码如下。.../** * 用户名 */ public String name; 也可以使用如下格式: /**用户名*/ public String name; 在 Java 编写过程中我们需要对一些程序进行注释

3K10
  • 代码解出,电梯停靠最佳位置

    大家好,我是查理 最近回家坐电梯,突然又想起电梯最佳停靠位置。 最早发现这个问题时候是两年前在杭州。当时住在一个蛮高端叫翡翠城小区,楼里有两部电梯。...当时就在想,这么做目的是什么?是为了让相对住在高层业主能更快坐到电梯?如果是这样,那这种一部停在中间,一部停在1层是不是最科学方式? 先从只有一部电梯情况开始分析。...我们假设楼有n层,到每一层去的人概率是一样, 同时从第x层下到1层概率也是一样。假设电梯停靠位置是p,那么可以推出当p等于1时候,总代价最低(全部人上楼,下楼电梯运行总楼层数)。...当有两部电梯时候,情况要复杂很多,很难通过不等式来推理。...使用程序模拟,代码如下: import sys from math import * #top floor N = 10 #elevator number M = 3 def distance(src,

    58030

    java文档注释符号_java注释符号

    1 JAVA语法基础 1.1 标识符 标识符可以简单理解成一个名字。 在Java中,我们需要给代码很多元素起名,包括类名、方法名、字段名、变量名等等。...需要注意是,除了上述50个关键字以外,true,false,null也不可以被用作标识符~ 1.3.1 注释 几乎所有编程语言都允许程序员在代码中输入注释 因为编译器会忽略注释,所以注释并不会影响程序运行结果...注释真正作用是: 它可以向任何阅读代码的人描述或者解释程序实现思路,如何使用以及其它任何相关信息, 提高代码可读性,方便后期维护与复用。 Java注释有3种: 1....快捷方式: 可以输入” /* ”之后按回车添加注释 3. 文档注释: 一般用来注释类和方法,通过注释内容来记录类或者方法信息. 格式: 以” /** ”开头。...,最好加D方便阅读 3.3 byte,short,char三种比int小整数可以范围内值直接赋值 byte b1=127;//对, byte b2=128;//错,超出byte范围 char c1

    10.3K21

    16个很骚代码注释,喜欢拿走

    注释 /*** * 这个公司没有年终奖,兄弟别指望了,也别来了,我准备辞职了 * 另外这个项目有很多*Bug* 你坚持不了多久,拜拜!...Never gonna tell a lie and hurt you. */ /*** * 致终于来到这里勇敢的人: * 你是被上帝选中的人,是英勇、不敌辛苦、不眠不休来修改我们这最棘手代码编程骑士..., only God and I understood what I was doing * Now, God only knows */ /*** * 写这段代码时候,只有上帝和我知道它是干嘛...changes will be undone. // sometimes I believe compiler ignores all my comments // 有时候我相信编译器忽略了我所有的注释...problem. // 虽然我不知道为什么这样管用,但它却是修复了问题 // If this comment is removed the program will blow up // 如果删了此处注释程序就炸了

    60230

    在线学习Java编程最佳方法

    掌握Java的人有很多话题。 好消息是,您可以在线找到很多内容。 在本文中,我们将对所有这些主题进行分类,并提供对文章和代码示例引用,这些文章和代码示例将指导您完成学习Java过程。...在Java中处理异常 Java异常处理教程(包含示例和最佳实践) 4.数据类型 Java 数据类型是编程中非常重要数据结构实现。 下面我们列出了最重要方法及其示例。...,请参见: Java字符串类示例 Java提供了许多使开箱即用即简单又有效方法。...将Collection复制到另一个Collection示例 以下比较将帮助您根据例决定最佳数据结构。...带有JDBC示例Spring事务管理示例 在Spring中了解事务注释 Spring @Transactional实际如何工作?

    1.7K20

    IDEA插件:快速删除Java代码注释

    背景 有时,我们需要删除Java代码注释。目前有不少方法,比如: 实现状态机。该方式较为通用,适用于多种语言(取决于状态机支持注释符号)。 正则匹配。该方式容易误判,尤其是容易误删字符串。...该方式局限性较强,比如不同语言可能有不同第三方库。 本文针对Java语言,介绍一种利用第三方库方式,可以方便快速地移除代码注释。 原理 这个第三方库叫做JavaParser。...将AST中剩余节点按一定规则打印出来。 在实践之前,我们先要了解Java几种注释类型: LineComment 单行注释。 BlockComent 块注释。...重启IDEA后,可以看到插件已安装成功: 此时我们就可以使用该插件,一键删除代码注释了。...传送门: 状态机编程思想(2):删除代码注释(目前支持C/C++和Java) - xiaoxi666 - 博客园​ 最后 给自己公众号打个广告,欢迎大家关注我公众号:xiaoxi666

    2.7K00

    java文档注释报错,java文档注释主要使用方法「建议收藏」

    * {@inheritDoc} 方法、类 可以集成上一个文档注释 * {@link} 类、方法 链接标签 * {@linkplain} 类、方法 链接标签、与上一个标签唯一不同就是因为字体不同,如果...JAVA 文档注释,类说明,HTML说明文档生成 有的时候,我们会写一些类,编译成.class文件,给别人使用,那么,别人不知道这个类有哪些方法,如何调用. 所以我们需要做一个类说明文档....可以采用在.java类里面进行注释,通过注释来生成类说明 … Java – 34 Java 文档注释 Java 文档注释 Java只是三种注释方式.前两种分别是// 和/* */,第三种被称作说明注释...:Java语言类源文件 … 如何为我们程序编写开发文档——Java文档注释 Java文档注释是用于生成Java API文档注释,通过在程序中类.属性.方法部分加上注释,就可以javadoc命令生成漂亮...注意,文档注释只说明紧跟其后java文档注释–javadoc用法 1.前言 Java中有三种注释方式.前两种分别是 // 和 /* */,主要用于代码注释,以此来方便代码可读性.第三种被称作说明注释或文档注释

    82220

    IDEA插件:快速删除Java代码注释

    背景 有时,我们需要删除Java代码注释。目前有不少方法,比如: 实现状态机。该方式较为通用,适用于多种语言(取决于状态机支持注释符号)。 正则匹配。...该方式局限性较强,比如不同语言可能有不同第三方库。 本文针对Java语言,介绍一种利用第三方库方式,可以方便快速地移除代码注释。 原理 这个第三方库叫做JavaParser。...它可以分析Java源码,并生成语法分析树(AST),其中注释也属于AST中节点。 因此核心思路即为: JavaParser解析源码并得到AST。 识别出注释类型节点并将其删掉。...将AST中剩余节点按一定规则打印出来。 在实践之前,我们先要了解Java几种注释类型: LineComment 单行注释。 BlockComent 块注释。...其中包含两段核心代码: 删除源码注释。首先读取当前文件内容也即源码,然后交给前面已经介绍过CommentsRemover.doAction处理,就拿到了删除注释源码。 格式化代码

    1.8K30

    神级代码注释鉴赏,喜欢就拿去

    注释 /*** * 这个公司没有年终奖,兄弟别指望了,也别来了,我准备辞职了 * 另外这个项目有很多*Bug* 你坚持不了多久,拜拜!...Never gonna tell a lie and hurt you. */ /*** * 致终于来到这里勇敢的人: * 你是被上帝选中的人,是英勇、不敌辛苦、不眠不休来修改我们这最棘手代码编程骑士..., only God and I understood what I was doing * Now, God only knows */ /*** * 写这段代码时候,只有上帝和我知道它是干嘛...changes will be undone. // sometimes I believe compiler ignores all my comments // 有时候我相信编译器忽略了我所有的注释...problem. // 虽然我不知道为什么这样管用,但它却是修复了问题 // If this comment is removed the program will blow up // 如果删了此处注释程序就炸了

    38230

    代码阅读方法最佳实践

    由此及彼地类比,我们可以容易理解到:编写伟大代码方式是阅读代码,阅读大量代码:高品质代码、低品质代码; 汇编语言代码、C 代码、C++代码Java 代码、PHP代码、Go 代码、Kotlin...因为,如果不这样,我们就会不断地重做别人已经经完成工作,重复过去已经 发生过成功和错误。 阅读代码 我们所观测到不是自然本身,而是大自然在我们所用观察方法下展现出来特性。...阅读高品质代码,还可以提高您编写代码水准。 代码可读性 我很遗憾地告诉大家,就在最近,我再次查看了我程序(质因子和井字游戏),它们没 有任何形式注释或文档。...代码阅读有许多可选择策略:自底向上和自顶向下分析、应用试探法和检查注释和外部文档,应该依据问题需要,尝试所有这些方法。 创造性代码布局可以用来提高代码易读性。...可以使用空格、临时变量和括号提高表达式易读性。可以用好缩进以及对变量名称明智选择,提高编写欠佳佳程序易读性。 编写、阅读代码时,要养成添加注释习惯。

    70620

    Transformer做多元时序预测最佳方法

    Transformer如何应用于时间序列预测一直是近期探讨一个核心问题,这里包括多变量建模处理方式、Transformer结构等。...在DLinear中,提出了线性模型打败Transformer模型;在后来PatchTST等工作中,又验证了Transformer有效性。...token独立进行attention Only future focuses on history:只有未来序列和历史序列做attention,未来序列和历史序列内部都不做attention 3、多变量建模方法...在上述过程中,每个变量是独立建模,建模过程中没有考虑到各个变量之间关系,和PatcchTST类似。...identifier:每个channel一个可学习向量,和token计算关系 Cross-attention:结合每个channeltoken和identifier进行attention 4、

    2.1K21

    java三种代码注释方式「建议收藏」

    一些代码量少较少程序,我们加不加注释对我们理解和修改代码没有太大影响;如果是淘宝;抖音等那种中大型程序,没有了代码注释,对于日后程序运行维护将是很大困难。...我们可以在平时编码过程中养成规范代码注释习惯,也是我们成为优秀程序员原因 2.java注释分类 Java注释分为以下三种:单行注释;多行注释;文档注释 1.单行注释 java代码中使用双斜杠单行注释...//,一般单行注释注释少量代码或者说明内容 ,格式为: // 单行注释 2.多行注释 java代码中使用多行注释/* */,一般使用多行注释大量代码或者说明内容 ,格式为: /* 多行注释 多行注释...*/ 3.文档注释 使用文档注释/** */,文档注释一般用于对类和方法进行功能说明 ,说明类编写时间和作者以及方法作用参数和返回值 3.1类上注释 /** * 类上文档注释 * @author...张三 * @version 1.10.0 */ 3.2方法注释 /** * 方法文档注释 * @param * @return * @throws */ 标签 描述 @author 标识一个类作者

    1.9K30

    编写高性能 Java 代码最佳实践

    摘要:本文首先介绍了负载测试、基于APM工具应用程序和服务器监控,随后介绍了编写高性能Java代码一些最佳实践。最后研究了JVM特定调优技巧、数据库端优化和架构方面的调整。以下是译文。...介绍 在这篇文章中,我们将讨论几个有助于提升Java应用程序性能方法。我们首先将介绍如何定义可度量性能指标,然后看看有哪些工具可以用来度量和监控应用程序性能,以及确定性能瓶颈。...我们还将看到一些常见Java代码优化方法以及最佳编码实践。最后,我们将看看用于提升Java应用程序性能JVM调优技巧和架构调整。...2、配置记录器 根据“Gatling第一步”所述,下面的代码创建一个名为EmployeeSimulationscala文件: class EmployeeSimulation extends Simulation...结论 在这篇文章中,我们围绕着提升Java应用性能探讨了许多概念。我们首先介绍了负载测试、基于APM工具应用程序和服务器监控,随后介绍了编写高性能Java代码一些最佳实践。

    1.2K30

    编写高性能 Java 代码最佳实践

    介绍 在这篇文章中,我们将讨论几个有助于提升Java应用程序性能方法。我们首先将介绍如何定义可度量性能指标,然后看看有哪些工具可以用来度量和监控应用程序性能,以及确定性能瓶颈。...我们还将看到一些常见Java代码优化方法以及最佳编码实践。最后,我们将看看用于提升Java应用程序性能JVM调优技巧和架构调整。...配置记录器 根据“Gatling第一步”所述,下面的代码创建一个名为EmployeeSimulationscala文件: ?...我们之前讨论基于Gatling测试就是一个很好方法。 选择合适垃圾收集器 Stop-the-world(STW)垃圾收集周期是影响大多数面向客户端应用程序响应和整体Java性能大问题。...结论 在这篇文章中,我们围绕着提升Java应用性能探讨了许多概念。我们首先介绍了负载测试、基于APM工具应用程序和服务器监控,随后介绍了编写高性能Java代码一些最佳实践。

    1.3K30

    Java注释

    单行注释 写法: //此行后面均是注释内容 例如://我是一行注释|´・ω・)ノ 多行注释 写法: /* 我是注释内容1 我是注释内容2 */ 单/多行注释作用: 增强代码可读性 文档注释...写法: /** *我是文档注释内容 */ 文档注释作用: 注释允许你在程序中嵌入关于程序信息。...说明注释,使你更加方便记录你程序信息。 javadoc标签 在开始 /** 之后,第一行或几行是关于类、变量和方法主要描述。 之后,你可以包含一个或多个各种各样 @ 标签。...每一个 @ 标签必须在一个新行开始或者在一行开始紧跟星号(*). 多个相同类型标签应该放成一组。例如,如果你有三个 @see 标签,可以将它们一个接一个放在一起。 示例:

    1.4K20

    为啥国内程序员写代码英文注释

    发现一个有趣现象,越是技术水平高程序员越是喜欢英文注释,反而是刚入行程序员为了表达清楚采用中文注释,在这首先承认一个事情真相,虽然国内有上百万程序员,但是编程语言主流还是在欧美,无论从编程语言起源还是编程生态建设方面欧美等国家有着优秀基因...为什么国内程序员英文注释 编程语言本身就是英语。...起码在国内因为不懂英文阻断了很多人学习编程道路,这是历史遗留下来问题,也不是短时间能够改变,中国早晚会拥有属于自己编程语言,因为任何一种编程语言诞生都有其存在价值,中文编程语言早晚会出现,而且早晚会被国人接受但从今天角度考虑还是需要很长一段时间...原汁原味英文编程文档更加具有权威性。 由于大量原汁原味编程资料都是英文完成,所以不懂得英语想要深刻去学习会遇到非常大困难。...国内程序员在编程时候时机情况是刚入行是习惯用中文注释,随着技术能力提升逐渐习惯于英文注释时间长了自然就入乡随俗了,从创造实际价值来看至少在当前阶段没有必要刻意去创造一种编程语言,技术能力整体提升之后

    1.7K20

    代码注释艺术,优秀代码真的不需要注释吗?

    Robert C.Martin 在 Clean Code 中提出一个观点:注释不能美化糟糕代码。能用代码表达直接代码表达,不能用代码表达,你再想想,如何能用代码表达。...但我们完全可以 Objects.requireNonNull() 来进行替代。同样代码作用,但可读性可理解性大不一样,JDK 里这段代码,确实让人遗憾。...我们可以通过选择更好变量名,更准确类与方法,更合理继承与派生来减少注释,但尽快如此,我们还是有非常多信息无法直接通过代码来表达。...,为 reverse 方法添加了足够多注释。...StringUtils 工具类中 isBlank 方法,写了非常详情注释,不仅包括方法逻辑,入参含义,甚至还包括具体示例。

    55020
    领券