由TODO引申出Java中的特殊注释//fixme，hack，bug

最新推荐文章于 2023-01-07 00:33:34 发布
最新推荐文章于 2023-01-07 00:33:34 发布
阅读量941 收藏 2
点赞数
分类专栏： java开发效率助手 文章标签： TODO 特殊注释 BUG
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_42945742/article/details/100578251
版权

在阅读源码和开发过程中，都遇见过别人写的TODO注释。按照字面理解就是将要做什么，一直理解就是解释该注释下面的代码干了什么。后来不经意间看到了别人写的文章，原来不止是这么简单。下面就把我整理的一部分注释跟大家分享一下。

TODO：该注释下方的代码将要实现的功能

FIXME：该注释下方的代码可能不满足后来的需求，需要进行修改

HACK：该注释下方的代码需要根据自己的需求去调整程序代码

BUG：该注释下方的代码存在bug

这一些是我们通常约定好的注释，大家一看就能明白。其实我们也可以自定义注释，方便自己开发。

自定义注释
在这里插入图片描述

天蓝色的风
关注
专栏目录
Vim中列出TODO与FIXME等备注的方法
09-15
在开发过程中，程序员常常会在代码中使用特定的关键字（如TODO, FIXME, HACK等）作为注释的一部分，以此来标记那些需要后续关注或修改的地方。这些关键字有助于提高代码的可读性和可维护性，但在实际操作中，如果...
leasot：从文件中的注释中解析并输出TODO和FIXME
02-19
根据文件中的注释智能地解析和输出TODO和FIXME 轻松提取，收集和报告代码中的TODO和FIXME。 该项目使用正则表达式以便从注释中提取您的待办事项。 评论格式 TODO: add some info 空格是可选的。 冒号是可选的。 ...
代码中特殊注释——TODO、FIXME、XXX、HACK
热门推荐
编程之路
03-28 5万+
代码中特殊注释——TODO、FIXME、XXX、HACK TODO：英语翻译为待办事项，备忘录。如果代码中有该标识，说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。 FIXME：可以拆成短语，fix me ，意为修理我。如果代码中有该标识，说明标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。 XXX：如果代码中有该标识，说明标识处代码虽然实...
Qt Creater-特殊注释TODO，FIXME
TemetNosce的博客
03-08 1413
TODO qt creater
代码注释 TODO / FIXME / XXX / NOTE / HACK / BUG
南方有乔木的博客
07-18 2236
代码注释 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或FIXME）的工具-Node.js开发
05-27
代码注释代码注释是Rails的“ ...代码注释基于两个npm模块，主要来自fixme，但也受节点注释的启发。 该模块的主要区别是：灵活定义源扫描目录传递与multimatch兼容的排除模式的能力从.gitignore f中读取排除列表的能力
java代码中注释TODD代表什么意识
weixin_35753431的博客
12-31 2546
在 Java 代码中，TODO 注释通常表示还有某些工作要做，但目前尚未完成。TODO 注释通常用于提醒程序员在之后的版本中需要完成某些工作。例如： // TODO: Fix this code 在上面的代码中，TODO 注释提醒程序员要修复这段代码。 总的来说，TODO 注释是一种常见的代码组织方式，可以帮助程序员在项目开发过程中更好地管理和跟踪工作。 ...
代码中特殊注释 TODO、FIXME、XXX、HACK
z_ssyy的博客
12-21 879
TODO、FIXME、XXX、HACK TODO: 待办事项，类似于只写了需求 FIXME: 修理我，代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。 XXX: 如果代码中有该标识，说明标识处代码虽然实现了功能，但是实现的方法有待商榷，希望将来能改进，要改进的地方会在说明中简略说明。 HACK: 英语翻译为砍。如果代码中有该标识，说明标识处代码我们需要根据自己的需求去调整程序代码。 ...
TODO / FIXME / XXX / NOTE / HACK / BUG
WWF_HelloWorld
04-08 5836
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 cir...
代码中特殊注释——TODO、FIXME、XXX、HACK、BUG、NOTE
淡淡风溶溶月
01-07 1864
NOTE/XXX/HACK/FIXME/BUG/TODO
css的标准注释,条件Hack
weixin_32136203的博客
08-03 204
条件Hack(CSS外部)HTML级Hack条件Hack定义和用法条件Hack属性值if条件共包含6种选择方式：是否、大于、大于或等于、小于、小于或等于、非指定版本是否：指定是否IE或IE某个版本。关键字：空大于：选择大于指定版本的IE版本。关键字：gt(greater than)大于或等于：选择大于或等于指定版本的IE版本。关键字：gte(greater than or equal)小于：选择小...
Eclipse中的TODO，FIXME和XXX
山不在高，有金则名
04-14 1880
Eclipse中默认有三种任务标记 1、TODO：等待实现的功能 2、FIXME：需要修正的功能 3、XXX：需要改进的功能 自定义：Window-->Preferences-->Java-->Compiler-->Task Tags
NOTE/XXX/HACK/FIXME/BUG/TODO
山茶树和葡萄树
02-10 2461
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 ...
常见代码重构技巧（非常实用）
程序员小乐
05-20 1221
点击上方 "编程技术圈"关注,星标或置顶一起成长后台回复“大礼包”有惊喜礼包！每日英文Man has to be crazy for once, whether it i...
VS中特殊的注释——TODO/UNDONE/HACK的使用
Guo_wenqiang
04-23 6794
在代码的后面添加形如下面注释： //TODO: (未实现）…… //UNDONE:（没有做完）…… //HACK：（修改）…… 等到再次打开VS的时候，找到 ：视图>任务列表 即可显示所有带有TODO注释的代码位置。 方便项目管理者，对代码的编写更加的灵活，节省了不少时间。
代码中的特殊注解 -- TODO、FIXME、XXX的作用
我在山城重庆，我希望能为这片软件沙漠地带贡献自己的一滴水，Stay tuned!
12-05 2万+
刚用eclipse创建class时候会自动生成TODO代码、今天在看项目中的source的时候发现了FIXME的注释、学习并记录如下： // TODO + 说明： 如果代码中有该注释，说明在该注释处有功能代码待编写，待实现的功能在说明中会简略说明。 // FIXME + 说明： 如果代码中有该注释，说明该注释处代码需要修正，甚至代码是错误的，不能工作，需要修
java //TODO
最新发布
01-03
在Java中，`//TODO`是一种常见的注释形式，用于标记代码中需要完成或需要进一步处理的部分。它通常用于提醒开发者在后续的开发过程中需要注意的地方。 以下是`//TODO`的几个常见用法示例： 1. 在catch块中使用`//TODO`注释，用于提醒开发者在异常处理中需要添加适当的处理逻辑，而不仅仅是简单地抛出异常或打印异常栈信息。 ```java try { // 一些可能会抛出异常的代码 } catch (Exception e) { //TODO: 添加适当的异常处理逻辑 } ``` 2. 在构造器或方法的重写中使用`//TODO`注释，用于提醒开发者在实现该构造器或方法时需要完成的部分。 ```java public class MyClass extends ParentClass { //TODO: 重写父类的某个方法 @Override public void someMethod() { // 实现方法的具体逻辑 } } ``` 请注意，`//TODO`只是一种注释形式，它本身并不会对代码产生任何影响。它的作用主要是提醒开发者在后续的开发过程中需要注意的地方。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值