TODO注解及其他类似注解说明

一、TODO注解及其他类似注解说明

在Java日常开发过程中,我们经常能看到 // TODO 注解,其作用和用法,网上很多文章讲的很好,在此不做赘述。

这里主要来介绍其类似的几种注解。

/// 这是对被注释的代码段做说明
// TODO 这是说明待完成的功能代码
// FIXME 这是说明待修改的功能代码
// DONE 这是说明已经完成的功能代码
// XXX 待删除的功能代码


public static void main(String[] args) {
    /// 演示地址才需要执行以下语句
    // System.out.println("Hello World.");

    // TODO 待实现拦截过滤方法
    System.out.println("待实现拦截过滤方法");

    // DONE 拦截过滤方法完成
    System.out.println("拦截过滤方法完成");

    // FIXME 该拦截过滤方法效率太差,要优化
    System.out.println("拦截过滤方法 1.0 版");

    // XXX 我看不懂这段代码,但我大受震撼,要删除这段代码
    System.out.println("祖传代码。。。");
    
}

二、修改注释样式

如下图所示,在IDEA中可以看出,除TODO 和 FIXME 有自带的样式外,其他均没有样式。

 如果需要我们可以修改或设置注解样式。

甚至可以添加自定义的注解。

### 关于 Java 注解 `@TOD` 的使用方法 Java 中的注解是一种元数据形式,可以提供关于程序代码的信息而不改变其实际逻辑。然而,在标准 Java SE API 或常见的第三方库中,并不存在名为 `@TOD` 的注解。可能是拼写错误或者指代的是其他类似注解。 如果是指 `@TODO`(通常用于标记待完成的任务),这是一种非正式的约定,开发者可以在源代码中使用该注解来提醒自己或其他团队成员某些需要后续处理的地方。以下是具体说明: #### 1. 自定义注解 `@Todo` 虽然 Java 并未内置 `@TOD` 或 `@TODO` 注解,但可以通过自定义注解实现类似功能。下面是一个简单的例子: ```java import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; // 定义 @Todo 注解 @Retention(RetentionPolicy.SOURCE) // 只在编译阶段有效 @Target(ElementType.METHOD) // 仅能标注在方法上 public @interface Todo { String value() default ""; // 提供可选的消息字段 } ``` #### 2. 使用示例 以下是如何在代码中应用上述自定义注解的例子: ```java public class Example { @Todo(value = "优化算法性能") public void processLargeData() { System.out.println("当前正在处理大数据..."); } @Todo("增加日志记录功能") public void logUserActivity() { System.out.println("用户活动已记录"); } } ``` 以上代码片段表明了两个尚未完全实现的功能点[^5]。 #### 3. 工具支持 许多现代 IDE(如 IntelliJ IDEA 和 Eclipse)都提供了对 `@Todo` 类型注解的支持。当开发者编写带有此类标签的方法时,IDE 能够自动识别并将它们列在一个专门的任务视图中以便跟踪进度[^6]。 #### 4. 注意事项 - **生命周期管理**:确保合理设置 Retention Policy (`SOURCE`, `CLASS`, or `RUNTIME`) 来决定何时以及如何访问这些注解。 - **适用范围控制**:通过 Target 属性限定注解的应用场景,比如类、方法还是变量级别等。 --- ###
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值