`
bugyun
  • 浏览: 556052 次
社区版块
存档分类
最新评论

java代码注释XXX todo fixme 的意义(转)

    博客分类:
  • Java
 
阅读更多

 

转:http://free0007.iteye.com/blog/1886526

 

特殊注释:

1 TODO

表示需要实现,但目前还未实现的功能

2 XXX

勉强可以工作,但是性能差等原因

3 FIXME

代码是错误的,不能工作,需要修复

 

TODO: + 说明
如果代码中有该标识,说明在标识处有功能代码待编写,待实现的功能在说明中会简略说明。

FIXME: + 说明
如果代码中有该标识,说明标识处代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明。

XXX: + 说明
如果代码中有该标识,说明标识处代码虽然实现了功能,但是实现的方法有待商榷,希望将来能改进,要改进的地方会在说明中简略说明。

IDEA查看todo:

ALT+6

 

分享到:
评论

相关推荐

    汇总所有代码注释(如TODO或FIXME)的工具-Node.js开发

    代码注释代码注释是Rails的“ ...代码注释基于两个npm模块,主要来自fixme,但也受节点注释的启发。 该模块的主要区别是:灵活定义源扫描目录传递与multimatch兼容的排除模式的能力从.gitignore f中读取排除列表的能力

    Vim中列出TODO与FIXME等备注的方法

    在开发过程中,程序员常常会在代码中使用特定的关键字(如TODO, FIXME, HACK等)作为注释的一部分,以此来标记那些需要后续关注或修改的地方。这些关键字有助于提高代码的可读性和可维护性,但在实际操作中,如果...

    myeclipse/eclipse设置java文档注释

    Java 文档注释(也称为 Javadoc 注释)是一种特殊格式的注释,它不仅可以帮助开发者了解代码的功能和用途,还可以自动生成 API 文档,方便他人阅读。Javadoc 注释通常以“/** ... */”的形式出现,并包含多种标签来...

    Eclipse Java注释模板.txt

    在进行Java开发的过程中,良好的代码注释习惯不仅能帮助自己快速回顾代码逻辑,还能方便其他开发者理解代码意图,从而提高整个团队的工作效率。Eclipse作为一款非常受欢迎的Java集成开发环境(IDE),提供了强大的...

    todo-list:在您的项目中查找 TODO、NOTE 和 FIXME。 按受让人和文件排序

    待办事项列表 Todo-list 启动一个服务器来查找 TODO、FIXME 和 NOTEs,将它们呈现在一个界面中,让您可以按受让人和文件进行排序。 服务器还将显示代码片段。作为应用程序使用Todo-list 可以作为应用程序安装和使用...

    eventuate-examples-java-spring-todo-list, 使用Eventuate构建的Java和 Spring Boot Todo列表应用程序.zip

    eventuate-examples-java-spring-todo-list, 使用Eventuate构建的Java和 Spring Boot Todo列表应用程序 待办事项列表示例应用程序it演示如何使用平台编写具有 microservices体系结构的应用程序,使用事件源Sourcing...

    leasot:从文件中的注释中解析并输出TODO和FIXME

    轻松提取,收集和报告代码中的TODO和FIXME。 该项目使用正则表达式以便从注释中提取您的待办事项。 评论格式 TODO: add some info 空格是可选的。 冒号是可选的。 必须在其自己的行中的注释(行或块)中( some ...

    todocheck:带有注释的TODO注释的静态代码分析器

    todocheck是用于注释的TODO注释的静态代码分析器。 通过使用来自任何问题注释它们,您可以创建可行的TODOs 。您将再也不会发现散布在您的代码库中的奥秘,未记录的TODO注释。 有关更多信息,请参。 目录 GitLab ...

    Go-astitodo:一个Golang库和CLI来解析GO代码中的TODO

    Go-astitodo 是一个基于 Golang 的工具,它的主要功能是帮助开发者解析和管理 GO 代码中的 TODO 注释。这个工具提供了库的形式,可以方便地集成到其他项目中,同时还有一个命令行界面 (CLI) 版本,使得开发者可以...

    SublimeLinter-annotations, 标记注释FIXME等注释的SublimeLinter 3插件.zip

    SublimeLinter-annotations, 标记注释FIXME等注释的SublimeLinter 3插件 sublimelinter注释 这个用于SublimeLinter插件的linter插件强调注释中注释,注释,TODO,@todo, XXX,以及自述文件。 它将与所有文件一起使用...

    Eclipse Java注释模板设置详解

    Eclipse作为一款流行的Java集成开发环境(IDE),提供了丰富的功能来帮助开发者更好地管理代码和注释。本文将详细介绍如何在Eclipse中设置Java注释模板,包括文件、类型、字段、构造器与方法以及重写方法等不同场景...

    Ruby-在代码中编写TODO以确保您能够实际执行它们

    在Ruby编程语言中,"TODO"是一个常见的注释标记,用于提醒开发者某个部分的代码需要进一步的工作或改进。"在代码中编写TODO以确保您能够实际执行它们"这个主题强调了在开发过程中有效管理和跟踪待办事项的重要性。...

    myeclipse java文件自动添加注释

    "myeclipse java文件自动添加注释"这一主题聚焦于MyEclipse IDE如何帮助程序员高效地为Java源代码添加标准注释。MyEclipse是一款强大的集成开发环境,尤其在Java EE应用开发中广泛应用。 首先,让我们深入理解什么...

    java注释模板

    在Java编程中,注释是不可或缺的一部分,它们用于提高代码的可读性和可维护性。Java注释模板是为了规范和简化编写注释的过程,确保团队成员遵循统一的标准。以下是一些关于Java注释模板的详细说明: 1. **文件...

    verify-todo:验证源代码中的TODO注释是否包含指向问题的链接

    验证待办事项具有链接验证// TODO代码中的// TODO注释是否包含指向Github问题的链接或匹配您指定的模式。 它不会代表您创建票证-而是验证票证链接已添加到TODO。基本用法一个简单的工作流程脚本如下所示: name: ...

    java注释规范

    Java 注释规范是 Java 语言中一个非常重要的部分,它不仅能够提高代码的可读性和可维护性,还能够帮助其他开发者更好地理解代码的逻辑和意图。下面我们将详细介绍 Java 注释规范的各个方面。 文件注释 文件注释是...

    smart_todo:在您的Ruby代码中增强TODO注释

    SmartTodo是一个库,旨在根据您的代码库中编写的TODO注释分配用户,并在需要提交给他们的TODO时提醒被分配者。 安装 将宝石添加到您的Gemfile中。 group :development do gem 'smart_todo' , require : false # No...

    git-pending:Git插件,用于在存储库中列出TODO,FIXME,TESTME,DOCME注释

    pending Git插件列出待办事项,修订,测试和文档注释以及详细信息安装运行以下命令以安装插件npm install - g git - pending用法打开任何git存储库并运行以下命令git pending 这将列出所有待处理的TODO , FIXME ,...

    todocheck是用于注释的TODO注释的静态代码分析器。-Golang开发

    todocheck是用于注释的TODO注释的静态代码分析器。 todocheck todocheck是用于注释的TODO注释的静态代码分析器。 通过使用来自任何受支持的问题跟踪器的问题注释它们,您可以创建可行的TODO。 您将再也不会发现散布...

Global site tag (gtag.js) - Google Analytics