代码中的特殊注解 -- TODO、FIXME、XXX的作用

最新推荐文章于 2024-06-20 19:55:02 发布
最新推荐文章于 2024-06-20 19:55:02 发布
阅读量835 收藏 1
点赞数
分类专栏： 【实用工具专栏】
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/soaringlee_fighting/article/details/78033401
版权
【实用工具专栏】 专栏收录该内容
128 篇文章 82 订阅 ¥39.90 ¥99.00
订阅专栏
本文介绍了代码中常见的三种特殊注解：TODO、FIXME和XXX。TODO标记待实现的功能，FIXME表示需要修复的代码错误，而XXX则用于指出待优化的代码段。这些注解帮助开发者跟踪代码改进需求。
摘要由CSDN通过智能技术生成

###Date: 2017/9/19

   在看代码的过程中，看到FIXME的注释，这里记录一下几种特殊注释的作用。

// TODO + 说明：

了解本专栏 订阅专栏 解锁全文
飞翔的鲲
关注
专栏目录
订阅专栏
【项目实战】JAVA代码中的任务标记（TODO、FIXME、【自定义】）
本本本添哥
06-26 966
例如: // XXX：表示此处的代码虽然实现了功能，但是性能太低，提醒你需要在后续阶段优化；
代码中的注释FIXME/TODO/XXX
振兴的博客
10-26 1996
注释TODO/FIXME/XXX的用法         参考网络搜索结果，谨作记录，如有雷同，可以忽略。       在查看别人代码的时候会见到这几种注释，不明所以，查看资料后终于有所了解，作此记录，以备不时之需。 1、TODO+说明    如果代码中有这个标示，说明有未完成的功能需要编写，说明中会做简单介绍。 2、FIXME+说明    如果代码中有这个标示，说明这里的代码有待改
编程规范: 代码中特殊注释TODO、FIXME、XXX 的含义
Nohysiwe的博客
07-27 4983
特殊注释 在编写代码的时候我们可以利用一些公认的特殊注释方式快速简介表达自己的目地 TODO: <说明> 通常写在一些函数的上方或者内部，当然，实际上你可想写哪儿就写哪儿。它表示该注释标识处，有一些代码功能还未实现，未来会实现，<说明> 中应该简单描述下该功能。 FIXME: <说明> 该注释表示该注释标记处的代码有问题或者是错误的，有可能无法正常工作，需要修复，<说明> 中应该简单描述下如何修复该问题。 XXX: <说明> 该注释表
程序中的TODO、XXX、FIXME
01-10 845
1、为什么要使用这些标签？ 我认为在程序中使用TODO、XXX、FIXME这些标签应该算是一件好事。 理由有如下两个方面： 1、 这些标签能够提醒编程人员，当前位置应该所做的事情，以便对程序进行改进。 2、 这些标签很容易被查找。有些IDE工具甚至为这些标签设置了高亮。     比如，XCode就会在左侧边框的警告/错误列表中将这些标签显示出来。(只有第二种方式，具体往下看)
程序猿的浪漫：TODO、FIXME、XXX 注释标签
我在Laputa
02-08 990
但是程序猿的世界总是有它自身的发展规律，通过学习前辈们的留下来的经验，代码编写有一些浪漫的约定规则，这些特殊的约定规则，帮助开发者还是读者传递一些代码线索，这些线索会穿越时空，起承转合，让前人后人之间心领神会。但这种实用性的需求，不论下至谭浩强，上至软件工程，乃至 Agile 也没有明确告诉开发者如何处理。从字面意思也很好理解，该关键字所表达的含义是待实现,目前尚未实现的功能。该关键字表达的含义是此处代码实现有问题，先临时实现,须要后续的修正。也是表示后续代码须要修正，更多强调的是对代码进行优化。
【Java】总结//TODO、//FIXME、//XXX 注释
付费专栏已不再维护，请勿购买
03-05 7990
Java注释 //TODO、//FIXME、//XXX 总结（主要基于Eclipse）
阿里Java代码规范
Kaptcha的学习
06-28 3667
代码规范一、编程规约(一) 命名风格(二) 常量定义(三) 代码格式(四) OOP 规约(五) 集合处理(六) 并发处理(七) 控制语句(八) 注释规约(九) 其它二、异常日志(一) 异常处理(二) 日志规约三、单元测试四、安全规约五、MySQL 数据库(一) 建表规约(二) 索引规约(三) SQL 语句(四) ORM 映射六、工程结构(一) 应用分层(二) 二方库依赖(三) 服务器 一、编程规约...
罗剑锋的C++实战笔记4-编码阶段能做什么：秀出好的codestyle
最新发布
qq_53280238的博客
06-20 484
在编码阶段，我们的核心任务就是写出在预处理、编译和运行等不同阶段里执行的代码，还记得那句编程格言吗：“任何人都能写出机器能看懂的代码，但只有优秀的程序员才能写出人能看懂的代码。所以，我们在编码阶段的首要目标，不是实现功能，而是要写出清晰易读的代码，也就是要有好的 code style。怎么样才能写出 human readable 的好代码呢？这就需要有一些明确的、经过实践验证的规则来指导，只要自觉遵守、合理运用这些规则，想把代码写“烂”都很难。在此，我强烈推荐一份非常棒的。
shared_to_me
03-30
shared_to_me
JAVA开发手册华山版 - 学习笔记
码出精彩
07-24 1110
JAVA开发手册华山版关于Java开发手册JAVA开发手册（华山版）下载一、编程规约1. 编程风格2. 常量定义3. 代码格式4. OOP规约5. 集合处理6. 并发处理7. 控制语句8. 注释规约9. 其他二、异常日志1. 异常处理2. 日志规约三、单元测试四、安全规约五、MySQL数据库1. 建表规约2. 索引规约3. SQL语句4. ORM映射六、工程结构1. 应用分层2. 二方库依赖3. 服务器七、设计规约附2：专有名词解释 最近开始实习，前一两周主要在学习（摸鱼），然后看了一下阿里巴巴的Java开
IntelliJ IDEA 中JAVA代码的任务标记（TODO、FIXME、【自定义】）
weixin_70280523的博客
03-15 1421
666
代码中三种特殊注释——TODO、FIXME、XXX
weixin_34396103的博客
07-24 490
在eclipse中，TODO、FIXME和XXX都会被eclipse的task视图所收集。在项目发布前，检查一下task视图是一个很好的习惯。进入window→show view→Other→输入tasks然后open就可以看到了。 //TODO + 说明： 如果代码中有该注释，说明在该注释处有功能代码待编写，待实现的功能在说明中会简略说明。 // FIXME + 说明： 如果代码中有该注释，...
代码中特殊注释——TODO、FIXME、XXX、HACK
热门推荐
编程之路
03-28 5万+
代码中特殊注释——TODO、FIXME、XXX、HACK TODO：英语翻译为待办事项，备忘录。如果代码中有该标识，说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。 FIXME：可以拆成短语，fix me ，意为修理我。如果代码中有该标识，说明标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。 XXX：如果代码中有该标识，说明标识处代码虽然实...
webstorm特殊注释标记（TODO、FIXME、自定义注释标记）
浩星
11-09 1438
webstorm中使用自定义的注释样式来增加开发效率。
IntellJ IDEA 中JAVA代码的任务标记（TODO、FIXME、【XXX】）
炸鸡小子的博客
12-08 2万+
【任务标记是以注释的方式定义】 一、作用： 1、代码量非常大的项目，在某一行中需要在后续阶段实现一个功能，如果不标注下次再找的时候就非常困难了，可以大大的提高开发效率！ 2、在团队合作中，还可以告诉别人某处敏感代码的状态。 二、以下为常见的两种注释标记： 1、// TODO: 表示在此处将要实现的功能，提醒你在后续阶段将会在此处添加代码 2、// FIXME: 表示此处的代码逻辑有出入，或者根...
小小TODO标识，你用对了吗？
码农小胖哥
02-02 1109
前言有时，您需要标记部分代码以供将来参考，比如: 优化，改进，可能的更改，要讨论的问题等。通常我们会在代码中加入如下的标记表示待办://TODO 我将要在这里做 xxx 你这样做，别人也...
Vue作用域插槽slot-scope深度解析与实例
在这个例子中，虽然`todo-list`组件本身并不知道如何显示对勾，但父组件可以通过作用域插槽接收`isDone`属性，并根据这个属性决定是否显示对勾。 总结来说，Vue的作用域插槽提供了一种灵活的方式，让父组件能够根据...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

飞翔的鲲

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值