代码中特殊注释——TODO、FIXME、XXX、HACK、BUG、NOTE

已于 2023-01-07 00:36:07 修改
阅读量1.7k 收藏 9
点赞数 4
文章标签： bug
于 2023-01-07 00:33:34 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_42952831/article/details/128586829
版权
本文介绍了代码中常用的标识符，如TODO表示待实现的功能，FIXME用于标记需要修正的代码，XXX提示可能存在的问题，HACK表示不完美的解决方案，以及BUG用于标记错误。这些注释帮助开发者提高代码质量和维护性。
摘要由CSDN通过智能技术生成

TODO：待办事项。如果代码中有该标识，说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。
No problem, but addtional code needs to be written (usually when you are skipping something)情未了

FIXME：意为待修理。如果代码中有该标识，说明标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。
This works, sort of, but it could be done better. (usually code written in a hurry that needs rewriting) Fuck Me

XXX：如果代码中有该标识，说明标识处代码虽然实现了功能，但是实现的方法有待商榷，希望将来能改进，要改进的地方会在说明中简略说明。
Warning about possible pitfalls, can be used as NOTE:XXX:陷阱

HACK：英语翻译为砍。如果代码中有该标识，说明标识处代码我们需要根据自己的需求去调整程序代码。
Not very well written or malformed code to circumvent a problem/bug. Should be used as HACK:FIXME:补锅踩雷填坑

BUG： There is a problem here.丢锅埋雷挖坑

NOTE：Description of how the code works (when it isn’t self evident) 汝等凡人

42952831
关注
  • 4
    点赞
  • 踩
  • 9
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Java代码注释XXX todo fixme
spring5555的专栏
03-04 936
特殊注释： 1 TODO 表示需要实现，但目前还未实现的功能 2 XXX 勉强可以工作，但是性能差等原因 3 FIXME 代码是错误的，不能工作，需要修复   TODO: + 说明： 如果代码中有该标识，说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。 FIXME: + 说明： 如果代码中有该标识，说明标识处代码需要修正，甚至代码是错误的，不能工作，需要修复
Vim中列出TODO与FIXME等备注的方法
09-15
在开发过程中，程序员常常会在代码中使用特定的关键字（如TODO, FIXME, HACK等）作为注释的一部分，以此来标记那些需要后续关注或修改的地方。这些关键字有助于提高代码的可读性和可维护性，但在实际操作中，如果...
代码注释 TODO / FIXME / XXX / NOTE / HACK / BUG
南方有乔木的博客
07-18 2164
代码注释 TODO / FIXME / XXX / NOTE / HACK / BUG TODO: 情未了 No problem, but addtional code needs to be written (usually when you are skipping something) 标识处有功能代码待编写，待实现的功能在说明中会简略说明。 FIXME: Fuck Me This works, sort of, but it could be don...
todo-list:在您的项目中查找 TODO、NOTE 和 FIXME。 按受让人和文件排序
06-08
待办事项列表 Todo-list 启动一个服务器来查找 TODO、FIXME 和 NOTEs，将它们呈现在一个界面中，让您可以按受让人和文件进行排序。 服务器还将显示代码片段。 作为应用程序使用 Todo-list 可以作为应用程序安装和使用。 npm install -g todo-list 然后导航到您的代码目录，并运行以下命令。 todo-list 您应该能够将浏览器导航到http://localhost:3000/并查看结果。 作为图书馆使用 var todolist = require ( "todo-list" ) ; todolist . findMarks ( "// TODO(bob): This is a TODO assigned to bob." ) ; /*[{ content: 'TODO(bob): This is a TODO assigned
代码中特殊注释——TODO、FIXME、XXX、HACK
热门推荐
编程之路
03-28 5万+
代码中特殊注释——TODO、FIXME、XXX、HACK TODO：英语翻译为待办事项，备忘录。如果代码中有该标识，说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。 FIXME：可以拆成短语，fix me ，意为修理我。如果代码中有该标识，说明标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。 XXX：如果代码中有该标识，说明标识处代码虽然实...
【5】Vscode Todo Tree插件使用和TODO、FIXME和XXX的注释使用说明以及自制自己的TODO图标样式！
丨汀、的博客
04-12 9943
1.Vscode Todo Tree插件安装 在vscode扩展中心，搜索todo tree然后安装， Todo Tree插件会有自带的icon图标样式，如下图： 2.TODO、FIXME和XXX的注释使用说明 TODO: + 说明： 如果代码中有该标识，说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。FIXME: + 说明： 如果代码中有该标识，说明标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。XXX: + 说明： 如果代码中...
TODO是什么意思
Li2992673708的博客
10-07 3536
是一个常用的注释或标记，用于在代码中标识出待完成的任务、需要改进的部分或需要进一步实现的内容。它可以帮助开发者和团队识别和处理待办事项，提醒代码的维护和改进，并促进协同开发和团队合作。注释，可以将某个地方标记为待办任务或需要完成的工作。TODO` 注释，可以在代码中留下提示，以便后续开发者在维护或改进代码时找到相关的改进点。注释通常是暂时性的，用于标记待办任务和改进点。注释，团队成员可以了解到其他人留下的工作提醒，以便在合适的时候进行处理。它通常用于提醒开发者或团队在后续的工作中需要注意或完成的内容。
任务列表中的 TODO、HACK 和 UNDONE 注释
weixin_30388677的博客
12-27 274
“任务列表”窗口中标记为 TODO、HACK 和 UNDONE 的项指示不影响项目编译但会导致运行时错误的代码问题。应在运行项目之前纠正这些错误。 使用就是 注释符号+TODO，如C#中 //todo 转载于:https://www.cnblogs.com/xiangniu/archive/2011/12/27/2303434.html...
leasot：从文件中的注释中解析并输出TODO和FIXME
02-19
轻松提取，收集和报告代码中的TODO和FIXME。 该项目使用正则表达式以便从注释中提取您的待办事项。 评论格式 TODO: add some info 空格是可选的。 冒号是可选的。 必须在其自己的行中的注释（行或块）中（ some ...
汇总所有代码注释（如TODO或FIXME）的工具-Node.js开发
05-27
代码注释代码注释是Rails的“ ...代码注释基于两个npm模块，主要来自fixme，但也受节点注释的启发。 该模块的主要区别是：灵活定义源扫描目录传递与multimatch兼容的排除模式的能力从.gitignore f中读取排除列表的能力
smart_todo:在您的Ruby代码中增强TODO注释
04-26
SmartTodo是一个库，旨在根据您的代码库中编写的TODO注释分配用户，并在需要提交给他们的TODO时提醒被分配者。 安装 将宝石添加到您的Gemfile中。 group :development do gem 'smart_todo' , require : false # No...
todocheck:带有注释的TODO注释的静态代码分析器
03-18
您将再也不会发现散布在您的代码库中的奥秘，未记录的TODO注释。 有关更多信息，请参。 目录 GitLab 怎么运行的 这是带注释的TODO的示例： // TODO J123: Fix this typo func fuu() { ... } 如果链接的问题J123是...
编程规范: 代码中特殊注释TODO、FIXME、XXX 的含义
Nohysiwe的博客
07-27 4848
特殊注释 在编写代码的时候我们可以利用一些公认的特殊注释方式快速简介表达自己的目地 TODO: <说明> 通常写在一些函数的上方或者内部，当然，实际上你可想写哪儿就写哪儿。它表示该注释标识处，有一些代码功能还未实现，未来会实现，<说明> 中应该简单描述下该功能。 FIXME: <说明> 该注释表示该注释标记处的代码有问题或者是错误的，有可能无法正常工作，需要修复，<说明> 中应该简单描述下如何修复该问题。 XXX: <说明> 该注释表
【Java】总结//TODO、//FIXME、//XXX 注释
付费专栏已不再维护，请勿购买
03-05 7858
Java注释 //TODO、//FIXME、//XXX 总结（主要基于Eclipse）
由TODO引申出Java中的特殊注释//fixme，hack，bug
qq_42945742的博客
09-06 917
在阅读源码和开发过程中，都遇见过别人写的TODO注释。按照字面理解就是将要做什么，一直理解就是解释该注释下面的代码干了什么。后来不经意间看到了别人写的文章，原来不止是这么简单。下面就把我整理的一部分注释跟大家分享一下。 TODO：该注释下方的代码将要实现的功能 FIXME：该注释下方的代码可能不满足后来的需求，需要进行修改 HACK：该注释下方的代码需要根据自己的需求去调整程序代码 BUG：该注释...
NOTE/XXX/HACK/FIXME/BUG/TODO
山茶树和葡萄树
02-10 2450
NOTE: Description of how the code works (when it isn’t self evident) 汝等凡人 XXX: Warning about possible pitfalls, can be used as NOTE:XXX:陷阱 HACK: Not very well written or malformed code to circumvent ...
note : 使用宏简化代码的输入
谢绝留言与私信
08-17 2113
在开源工程中， 看到类似下面的代码很蛋疼.   ReLoadNtosCALL((PVOID)(&RObReferenceObjectByHandle),L"ObReferenceObjectByHandle",g_ulSystemKernelModuleBase,(ULONG)g_pImageModuleBase); ReLoadNtosCALL((PVOID)(&RKeInitializ
odoo17 翻译一个小bug
最新发布
fqfq123456的专栏
08-09 330
标红处，但在zh_CN.po中明显已经翻译过来了，采取暴力点的，直接把base下的base.pot删除，再更新一下，可以正常显示了。odoo17 翻译一个小bug。
8.java 中代码注释有哪些?
09-15
Java 中的代码注释主要有以下几种类型： 1. 单行注释：以双斜杠（//）开头。该类型注释只在一行中有效，用于对代码进行简单的解释和说明。 2. 多行注释：以 /* 开头，以 */ 结尾。该类型注释可以跨越多行，用于对代码块或多行代码进行注释和解释。 3. 文档注释：以 /** 开头，以 */ 结尾。文档注释主要用于生成程序的文档API，通常用于对类、方法、字段等进行详细的说明和解释。在编写文档注释时，通常需要遵循特定的标记格式，例如使用 @param 标记对方法的参数进行描述，使用 @return 标记对方法的返回值进行描述等。 4. TODO 注释：以 TODO 开头，用于标记代码中待完成的任务或需要改进的部分。它可以提醒开发者在之后的开发过程中需要注意相关的代码部分。 5. FIXME 注释：以 FIXME 开头，用于标记代码中已经存在的问题或需要修复的错误。它可以为开发者提供一个暂时的解决方案，待修复后再进行修改。 这些注释类型在 Java 代码中可以帮助开发者更好地理解代码的功能和设计意图，并且在后续的维护和优化过程中也起到了重要的作用。在编写注释时，需要注意注释的准确性、简洁性和易读性，提高代码的可维护性。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值