三种代码中特殊的注释-TODO、FIXME、XXX详解

最新推荐文章于 2022-09-19 20:15:43 发布
最新推荐文章于 2022-09-19 20:15:43 发布
阅读量1.4k 收藏 5
点赞数
CC 4.0 BY-SA版权
分类专栏： 笔记
原文链接：https://blog.csdn.net/hanhailong726188/article/details/46420271?ops_request_misc=%25257B%252522request%25255Fid%252522%25253A%252522161224840916780299060862%252522%25252C%252522scm%252522%25253A%25252220140713.130102334..%252522%25257D&request_id=16122484
本文详细解释了三种常用的代码注释符号：TODO、FIXME、XXX的含义及使用场景。这三种注释帮助开发者标记需要后续关注的任务、需要修复的问题以及需要优化的部分。了解这些注释的正确使用方式对于提升代码质量和团队协作效率至关重要。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

三种代码中特殊的注释-TODO、FIXME、XXX详解

 

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

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

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

在项目发布前，检查一下task视图是一个很好的习惯。此外，在eclipse中，我们可自定义自己的特殊注释标签。如在C/C++中，进入window—>preferences—>C/C++—>Task Tags窗口即可添加特殊标签，默认只有TODO、FIXME和XXX。

分布式爬虫scrapy-redis源码超级详解
thc151297的博客
04-14 713
这几天完成了分布式爬虫的学习，发现了解scrapy-redis源代码对于分布式爬虫的学习真的很重要，废话少说，直接上干货： 文章目录1.创建项目2.源代码解析2.1 Connection.py2.2 defaults.py2.3 dupefilter.py2.4 picklecompat.py2.5 pipeline.py2.6 queue.py2.7 scheduler.py2.8 spider...
Scrapy-redis分布式爬虫详解
wwxxee
12-30 532
1. 分布式爬虫原理 Scrapy单机爬虫有一个本地爬取队列Queue，如果新的Request生成就会放到队列里面，随后Request被Scheduler调度，之后Request交给Downloader执行。分布式爬虫有多个Scheduler和多个Downloader，而爬取队列始终为一个，也就是共享爬取队列，这样才能保证Scheduler从队列里调度某个Request之后，其他的Schedule...
todo:用C语言编写的一个简单的跨平台Todo应用程序
05-25
去做 这是一个用C语言编写的简单待办应用程序。 用法 查看待办事项清单： todo 更改名称： todo -n Things to Do 要添加新任务： todo buy milk todo "eat cookies" todo 1 pour milk 要编辑任务： todo -e 2 buy more milk 移动任务： todo -m 3 2 标记任务： todo 1 删除任务： todo -r 1 要在任务前添加空间，请执行以下操作： todo -s 2 帮助： todo -h 建造 运行make （或在Windows上为nmake ）。 如果您使用的是Visual Studio，请打开项目并构建Release。 安装 运行sudo make install来安装到/usr/local 。 要安装到另一个位置，请首先运行configure ：
Eclipse中Java代码注释XXX、TODO、FIXME的意义
I'm Learning!
11-27 1万+
今天看到一篇文章，谈到现在很多人学JAVA不会使用工具，比如TODO啊之类的，我一想其实我也不会，以前都是直接删除掉的，然后找了点资料看看，觉得这几个注释还是很有用的。 特殊注释： 1、 TODO 表示需要实现，但目前还未实现的功能 2 、XXX 勉强可以工作，但是性能差等原因 3 、FIXME 代码是错误的，不能工作，需要修复
代码中的特殊注释
PHP从入门到放弃
06-16 752
本人PHP菜鸟，今天在做功能的时候发现特殊代码。 感觉语句有语法错误，但是执行还不报错，百思不得姐，于是度娘一下，原来代码中还有特殊的注释方式，瞬间感觉好村 下面说下特殊注释吧。 TODO: + 说明： 如果代码中有该标识，说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。 FIXME: + 说明： 如果代码中有该标识，说明标识处代码需要修正，甚至代码是错误的，
C++中的特殊注释
微念的博客
05-19 1325
引子         我们知道，在C++中常用“//”进行单行注释，用“/**/”进行多行注释，那什么是特殊注释？ 介绍         特殊注释是一些通用的，能够被编译器识别的特殊字符。比如说，我们常用的特殊注释有“
代码中特殊注释——TODO、FIXME、XXX、HACK
热门推荐
编程之路
03-28 6万+
代码中特殊注释——TODO、FIXME、XXX、HACK TODO：英语翻译为待办事项，备忘录。如果代码中有该标识，说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。 FIXME：可以拆成短语，fix me ，意为修理我。如果代码中有该标识，说明标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。 XXX：如果代码中有该标识，说明标识处代码虽然实...
SublimeLinter-annotations 插件使用详解：标记代码注释的利器
在软件开发过程中，代码注释是沟通代码意图和提醒后续工作的重要工具。开发者在代码中加入此类注释，通常是为了记录需要解决的问题、尚未完成的功能或是需要改进的部分。然而，随着项目规模的增长，这些注释可能会被...
todo-webpack-plugin：Webpack生成TODO报告新插件介绍
todo-webpack-plugin 的主要功能是在构建过程中查找标记为待办事项的注释（例如：`// TODO: 完成XXX功能` 或 `// FIXME: 修复XXX错误`），然后根据用户的配置将这些待办事项的信息输出为不同格式的报告。支持的报告...
Scrapy-redis 源码分析 及 框架使用
墨鱼菜鸡
07-11 676
From：https://blog.csdn.net/weixin_37947156/article/details/75044971 From：https://cuiqingcai.com/6058.html Scrapy-redis github：https://github.com/rmax/scrapy-redis scrapy-redis分布...
Java代码中特殊注释
weixin_38168918的博客
08-21 166
Java代码中特殊注释 TODO: + 说明：标识处有功能代码待编写，待实现的功能在说明中会简略说明。FIXME: + 说明：标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。XXX: + 说明：标识处代码虽然实现了功能，但是实现的方法有待商榷，希望将来能改进，要改进的地方会在说明中简略说明。 转载于:https://www.cnblogs.com...
代码中的特殊注释标记
村中少年的专栏
04-21 2912
TODO，FIXME，XXX等特殊的注释标记
TODO注释用法
weixin_30756499的博客
06-26 604
在看牛腩新闻发布系统过程中老师讲到了这样一种注释方法很好用，在比较大的项目过程中，类模块会很多，工作量也会很大，在未完成的工作项目中我们怎样进行标记呢？这是一个值得考虑的问题。Visual Studio 2010为我们提供了很多编写代码的小技巧。 TODO注释：类似于我们的书签，标记下次我们需要做的工作。 public DataTable SelectHotNews() ...
C#编程好习惯--TODO注释使用
jeson006的专栏
11-16 4732
TODO注释使用后，可以帮助记录项目中未完成的任务都有哪些。 在代码段里使用TODO注释，如 “//TODO：此处还没测试通过” 在View->Task List,选择Comments,即可以查看项目中所有标记“TODO”的位置。 PS：在使用Resharp工具的时候，标记为TODO的地方会被标记为高亮颜色，以特别提醒。
Python 代码智能感知 —— 类型标注与特殊的注释（所有人都需要知道）
小康2022的博客
09-19 1304
一个不会写好的类型标注和注释的Python程序员，是让使用TA的代码的人都痛苦无比的事情……
编程规范: 代码中特殊注释TODO、FIXME、XXX 的含义
Nohysiwe的博客
07-27 5933
特殊注释 在编写代码的时候我们可以利用一些公认的特殊注释方式快速简介表达自己的目地 TODO: <说明> 通常写在一些函数的上方或者内部，当然，实际上你可想写哪儿就写哪儿。它表示该注释标识处，有一些代码功能还未实现，未来会实现，<说明> 中应该简单描述下该功能。 FIXME: <说明> 该注释表示该注释标记处的代码有问题或者是错误的，有可能无法正常工作，需要修复，<说明> 中应该简单描述下如何修复该问题。 XXX: <说明> 该注释表
在XCode 4中使用TODO FIXME等标记
工作流水薄
03-16 3639
在XCode中我们可以用类似这样的注释来方便我们标记需要修改的部分: // TODO: // FIXME: // !!!: // ???: XCode 4.1由于BUG不能使用这一功能了,网上有一种变通方法,可以在编译后的Warning里面看到我们标记的TODO, FixME等。 原文:http://stackoverflow.com/questions/5891193/xco
vs2010下c++程序使用TODO注释设置方法
xinhuo11的专栏
09-03 4718
用Eclipse写JAVA时已经习惯了在注释里写TODO，然后在Tasks小窗口中或代码区右侧滚动条处就能够看到当前source页里的所有TODO，用起来很方便。 用VS 2010也留了不少TODO，才发现开了VS的Task List窗口竟然看不到代码页里的TODO位置。看了一下Microsoft的官方Blog,发现原来只有VC++用这个功能时是需要手动开启的，VB、C#都是直接开启的。VC++
c 语言 todo 用法,Tip：iOS开发中关于TODO的用法
weixin_35629057的博客
05-24 1546
背景我们在平时的开发编程中，多多少少都会遇到一些功能的代码，当下不能很好的实现，或因为业务逻辑或因为思路，再或者因为时间。此时我们需要写一些// TODO：和// FIXME：的注释来提醒自己在的将来要去完善这些代码。今天这里给大家讲述下如何用好这些注释，并起到更好的作用。使用SwiftLint讲这里，有人疑惑不是要说TODO么，怎么又安利SwiftLint，SwiftLint是一个代码分析工具。...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值