代码中特殊的注释技术——TODO、FIXME和XXX的用处

最新推荐文章于 2025-02-06 05:03:31 发布
转载 最新推荐文章于 2025-02-06 05:03:31 发布 · 607 阅读 · 0

本文介绍了三种常用的代码注释符号：TODO、FIXME 和 XXX 的含义及应用场景，帮助开发者更好地理解和使用这些注释来提高代码质量。

source: http://blog.youkuaiyun.com/reille/article/details/7161942


TODO用来表示该处需要实现未个功能，但还未实现

FIXME表示该处的功能实现有bug，需要修复

XXX表示该处的功能实现有等商榷

BalterNotz
关注
eclipse中的特殊注释TODO FIXME XXX
天将降大任于是人
07-08 6873
在eclipse中，TODO、FIXME和XXX都会被eclipse的task视图所收集。在编码过程中，可以使用注释来标记未完成的功能，在提交代码前检查task视图，保证所有功能均完成编码。 此外，在eclipse中，我们可自定义自己的特殊注释标签。进入window—>preferences—>Java—>Compiler—>Task Tags窗口即可添加特殊标签，默认只有TODO、FIXME和
代码注释TODO、FIXME、XXX
花木兰
06-05 1043
#TODO：有功能代码带编写 #FIXME： 有代码待改进或者不理想 #XXX： 实现方法待改进
IntelliJ IDEA 特殊注释TODO、FIXME、XXX
qq_25775675的博客
02-21 4914
如果代码中有该标识，说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。
IDEA设置专属注释模板
qq_37874136的博客
01-07 917
本文主要介绍如何用Intelij Idea配置类及方法的注释模板提高代码注释效率 一、类注释配置 创建文件后, 编译器会在类名前面生成固定的注释, 在阿里巴巴Java开发手册里也明确写到所有的类都必须添加创建者和创建日期。 1、配置效果 2、配置步骤 File → Settings → Editor → File and Code Templates → Includes → File Header 提供可复制注释模板 (✪ω✪) /** * @className: ${NAME} * @descrip
IDEA/GoLand 添加自定义特殊注释【注释高亮】
勿忘初心
11-29 3465
IDEA只有两种特殊注释：TODO: + 说明：FIXME: + 说明：
IDEA 添加自定义特殊注释【注释高亮】
Suprit's blog
05-19 9924
IDEA只有两种特殊注释： TODO: + 说明： 如果代码中有该标识，说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。 FIXME: + 说明： 如果代码中有该标识，说明标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。 很显然，有时候并不够用，在此推荐大家添加新的特殊注释，我添加了一个keypoint，表示这里是关键点，非常常用，具体操作过程如下： 注意路径写法按照上面的来写，把这个勾去掉就可以自己设置颜色 效果： ...
代码中的特殊注解 -- TODO、FIXME、XXX的作用
优快云明星博主，认证博客专家，视频、Matlab领域优质创作者。
09-19 1105
###Date: 2017/9/19    在看代码的过程中，看到FIXME的注释，这里记录一下几种特殊注释的作用。 // TODO + 说明： 如果代码中有该注释，说明在该注释处有功能代码待编写，待实现的功能在说明中会简略说明。 // FIXME + 说明： 如果代码中有该注释，说明该注释处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何
【项目实战】JAVA代码中的任务标记（TODO、FIXME、【自定义】）
奶爸的编程之路，也就一周冷个三天，欢迎关注我的微信公众号：本本本添哥
06-26 1649
例如: // XXX：表示此处的代码虽然实现了功能，但是性能太低，提醒你需要在后续阶段优化；
为Source Insight添加TODO、FIXME等注释标签的高亮
Azure的博客
09-29 5312
在程序中加入TODO、FIXME等特殊的注释标签有助于提高代码编写效率，特别是多人协作的情况下。一般用法如下： TODO: + 说明： 如果代码中有该标识，说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。 FIXME: + 说明： 如果代码中有该标识，说明标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。 XXX:
IDEA的三个特殊注释&常用快捷键
weixin_51246903的博客
02-01 1067
idea的快捷键
IntelliJ IDEA集成开发环境（IDE）特殊功能的注释用途的示例
资深全栈开发工程师
06-15 241
IntelliJ IDEA是一款功能强大的集成开发环境（IDE），支持各种编程语言和技术。在IDEA中，可以使用各种特殊功能的注释来实现更高效的开发和维护。这些特殊功能的注释可以帮助您更好地组织和维护代码，并提高代码的可读性和可维护性。在使用这些注释时，请注意保持一致性和标准化，以便其他开发人员和您自己能够更轻松地理解和使用代码。
IntelliJ IDEA中好玩的注释
神在异乡
12-09 4813
1.TODO comments -待办事项注释 写代码时，有时候写着写着突然就有个线上的bug或者有个更紧急的需求，不得不放下正在写的东西，去做别的事。当那件事情忙完之后，回到原来的代码，不知道自己写到哪了。需要凭着记忆找半天。 这时候有个非常好的注释，//todo，如果代码中有该注释，注释会高亮显示，并且会在todo窗口中罗列出所有有todo注释的地方，点击即可跳转对应的地方，方便你定位代...
在IDEA中高亮的注释
u012632105的博客
02-06 851
IDEA 默认支持TODO和FIXME两种特殊注释，但可以通过以下步骤添加自定义特殊注释：打开设置（File->Settings），选择Editor->TODO。在Patterns中点击加号（），添加自定义的注释标签（如NOTEWARNING等）。设置注释标签的颜色，确保不使用默认主题颜色，选择自己喜欢的颜色。点击“OK”保存设置。
Intellij idea的各种注释方式
努力奋斗
11-12 966
在代码的开发过程中,会需要添加格式各样的注释,下面介绍几种常见的注释方式: 注意:本人使用的mac本，主要以mac的键为例子,command键是windows的ctrl 1.行注释 command+/ 2.块注释command+shift+/ 3.方法注释,需要注释的地方输入/**,点击回车 ...
Java 代码特殊注释详解
chenshun123的博客
07-12 1210
TODO，FIXME ，XXX  用于标记，方便返回处理操作 TODO : 在标识处有功能代码待编写，待实现的功能在说明中会简略说明 注：点击右边蓝色标记处，回到标记处 FIXME : 标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明 XXX : 标识处代码虽然实现功能，但是实现的方法有待商榷，希望将来能改进，要改进的
Java| Java特殊注释(XXX,TODO,FIXME)解释说明
YvesHe的专栏
10-16 5134
测试代码package cn.com.yves;public class Test { public static void xxx() { // XXX 勉强可以工作，但是性能差等原因. } public static void todo() { // TODO 表示需要实现，但目前还未实现的功能. } public static
编程规范: 代码中特殊注释TODO、FIXME、XXX 的含义
Nohysiwe的博客
07-27 6252
特殊注释 在编写代码的时候我们可以利用一些公认的特殊注释方式快速简介表达自己的目地 TODO: <说明> 通常写在一些函数的上方或者内部，当然，实际上你可想写哪儿就写哪儿。它表示该注释标识处，有一些代码功能还未实现，未来会实现，<说明> 中应该简单描述下该功能。 FIXME: <说明> 该注释表示该注释标记处的代码有问题或者是错误的，有可能无法正常工作，需要修复，<说明> 中应该简单描述下如何修复该问题。 XXX: <说明> 该注释表
//FIXME
weixin_30522095的博客
12-29 911
//FIXME 转载于:https://www.cnblogs.com/kakaisgood/p/8145183.html
代码特殊注释有哪些
最新发布
08-08
在编程中，特殊注释是开发者用来标记特定任务、说明代码状态或提供额外信息的重要工具。它们不仅有助于代码的可读性和可维护性，还能协助团队协作和代码审查。以下是几种常见的特殊注释语法及其用途： ### 1. `TODO...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值