Java中的//TODO、//FIXME、//XXX 注释

简介: 本文以Eclipse为参考,介绍Java中的//TODO、//FIXME、//XXX 注释的含义。

TODO、FIXME、XXX

  • //TODO: 表示待实现的功能
  • //FIXME: 代码存在Bug,不能Run或运行结果不正确,需要修复
  • //XXX: 勉强可以工作,但是实现的方法不一定很好

TODO

//TODO something

顾名思义,//TODO说明标识处有功能代码未实现,待实现的功能说明会在//TODO后面简略表述。

FIXME

//FIXME something

顾名思义,//FIXME说明标识处代码需要修正。被//FIXME表示的代码基本是错误的、不能工作的、需要修复的,修正的说明会在//FIXME后面简略表述。

XXX

//XXX something

如果代码中有//XXX,说明标识处代码虽然实现了功能,但是实现的方法不一定很好,留待商榷并希望未来版本中能改进,要改进的说明会在//XXX后面简略表述。

IDE显示

Eclipse

除了TODO和FIXME,XXX还是识别的
在这里插入图片描述

IntelliJ IDEA

只识别TODO和FIXME,不识别XXX
在这里插入图片描述

Eclipse-Tasks栏视图

所有的特殊注释都会被识别,我没额外配置,其实自己可以调的。
在这里插入图片描述

Eclipse自动生成的TODO注释

Eclipse可以自动生成TODO注释,我印象中有catch语句块和重写构造器、方法……

catch块的TODO

catch块之所以标上TODO主要是为了告诉开发者,应该去做好异常处理而不是简简单单的抛出异常或者打印异常栈。
在这里插入图片描述

构造器和重写方法的TODO

生成的TODO是也是提醒开发者不要空有壳子,应该认真地编写具体的实现代码。
在这里插入图片描述
在这里插入图片描述

说明

虽然我们知道了三者的实际表示的意义,但标注归标注,标注的目的是为了解决问题。所以怎么加上的,就怎么努力更正并删去吧!

相关文章
|
16天前
|
Java 测试技术 程序员
💡Java 零基础 | 深入理解注释的重要性与应用
【10月更文挑战第10天】本文收录于「滚雪球学Java」专栏,专业攻坚指数级提升,希望能够助你一臂之力,帮你早日登顶实现财富自由🚀;同时,欢迎大家关注&&收藏&&订阅!持续更新中,up!up!up!!
19 5
|
2月前
|
Java API 开发者
Java 注释规范
Java中的注释规范包括单行注释(`//`)、多行注释(`/* ... */`)和文档注释(`/** ... */`)。单行注释适用于简短说明,多行注释用于较长描述,文档注释则专为自动生成API文档设计。注释应清晰明了、及时更新,避免冗余,并详细说明参数和返回值。遵循这些规范有助于提高代码的可读性和可维护性。
|
3月前
|
Java C# 容器
逻辑运算符Java代码的注释
这段代码及文字介绍了一个简单的Java程序以及Java编程的基础概念。代码展示了如何输出“Hello Word”。接着,用贴近生活的比喻解释了`package`(包)、`public`(访问修饰符)、`class`(类)、`static`(静态)和`void`(空)的概念。此外,还介绍了`System.out.println()`方法。进一步讲解了Java中的注释、数据类型(包括整型、浮点型、字符型和布尔型),变量和常量的概念,以及运算符、类型转换、赋值运算符、关系运算符与逻辑运算符等基础知识点。通过生动的例子帮助初学者更好地理解和记忆。
25 2
|
3月前
|
Java
【Java 第三篇章】注释、数据类型、运算符
【8月更文挑战第2天】 Java支持三种注释:单行(`//`)、多行(`/*...*/`)及文档注释(`/**...*/`)。它定义了八种基本数据类型,包括四种整数类型(`byte`、`short`、`int`、`long`),两种浮点类型(`float`、`double`),一种字符类型(`char`)和一种布尔类型(`boolean`)。数据类型之间可以自动转换或通过强制转换改变,但后者可能导致精度损失。Java中的运算符涵盖算术(如`+`、`-`)、赋值(如`=`)、比较(如`==`)、逻辑(如`&&`)和三目运算符等。例如,算术运算可用于执行基本数学计算,而逻辑运算符用于组合条件判断。
20 1
|
5月前
|
Java 编译器
Java健壮性 Java可移植性 JDK, JRE, JVM三者关系 Java的加载与执行原理 javac编译与JAVA_HOME环境变量介绍 Java中的注释与缩进 main方法的args参数
Java健壮性 Java可移植性 JDK, JRE, JVM三者关系 Java的加载与执行原理 javac编译与JAVA_HOME环境变量介绍 Java中的注释与缩进 main方法的args参数
50 1
|
5月前
|
存储 Java 程序员
Java入门——基本语法(注释、字面量、变量、使用变量的注意事项、关键字、标识符)
Java入门——基本语法(注释、字面量、变量、使用变量的注意事项、关键字、标识符)
37 2
|
5月前
|
Java Maven
java运行jar包提示 “XXX中没有主清单属性”,配置maven插件
java运行jar包提示 “XXX中没有主清单属性”,配置maven插件
|
5月前
|
Java C# 容器
第一行Java代码的注释和相关解读
第一行Java代码的注释和相关解读
50 0
|
5月前
|
Java API
Java基础之注释
Java中的注释用于添加代码说明,分为单行、多行和文档注释。单行注释以`//`开始,多行注释以`/*...*/`包围,文档注释`/**...*/`用于生成API文档,如Javadoc。`@param`、`@return`等标签提供方法详情。注意,Java不支持嵌套注释。运行包含文档注释的代码,可通过`javadoc`命令生成API文档。示例代码展示了如何创建和使用文档注释。
25 0
|
5月前
|
算法 Java Go
【经典算法】LeetCode 392 判断子序列(Java/C/Python3/Go实现含注释说明,Easy)
【经典算法】LeetCode 392 判断子序列(Java/C/Python3/Go实现含注释说明,Easy)
55 0