#XXX在代码注释中的含义是什么？
我在代码中看到了很多,甚至vim都将它标记为特例.#TODO并且#FIXME是另外两个修复标记vim高亮但是什么#XXX意思？
Ste*_*tef 124
XXX在评论中通常是单挑.它可能是:
- 没有完全正确实现的东西.
- 以后应该修复的东西.
- 突出显示可能的问题点.
- 你不确定的东西,一个问题.
我经常更喜欢像FIXME或TODO或更像描述性的标签HACK.XXX通常用作上述所有内容.
在FreeBSD代码交叉引用上搜索'XXX' 是许多用法的一个很好的例子.有成千上万......
- 这证实了我的原始猜测,它只是一个捕获所有标记,以指示其他程序员强调该评论作为要查看的东西. (5认同)
- 源代码中的@ЯрославРахматуллин我总是会以“这是一个难看的hack作业，但似乎工作得很好”的意义来阅读它-您想稍后进行清理，但并不紧急。我没有使用它（我通常使用`TODO`或`XXX`），但这就是我要解释的方式。 (2认同)
小智 79
NOTE:代码如何工作的描述(当它不是不言自明的时候).XXX:关于可能的陷阱的警告,可以用作NOTE:XXX:.HACK:没有很好的编写或格式错误的代码来规避问题/错误.应该用作HACK:FIXME:.FIXME:这有点好用,但可以做得更好.(通常是急需编写的代码需要重写).BUG:这里有一个问题.TODO:没问题,但是通常在跳过某些东西时需要编写附加代码.
至少这就是我对这些标签的教导方式.基本上前两个(NOTE和XXX)用于信息,不需要任何操作.虽然最后三个(FIXME,BUG和TODO)确实需要采取行动.HACK介于两者之间(我认为几乎没用过).
- 好清单.我也喜欢"LAZY"(不像FIXME或HACK那样重要)和"OCD"(已知的过度工程). (2认同)
- 您是否真的这样使用XXX？我已经看到XXX具有更高的优先级，这意味着“这是必须在代码提交修订控制之前解决的问题”。这是在Google内部自动执行的方式，因此您可能会在代码检查期间看到XXX，但是只有在XXX消失后才能提交代码。寿命较长的待办事项注释可以标记为[TODO，只要附加了某人的姓名或错误ID，便可以提交。]（https://google.github.io/styleguide/cppguide.html# TODO_评论） (2认同)
nik*_*nik 20
选择之间
FIXME并且XXX很难.
XXX似乎更常见,但描述性更差.
此外,XXX在一段
具有未知值的代码中是一个有用的占位符.因此
FIXME是首选的拼写.
Sun说,XXX并且FIXME略有不同,给予XXX更高的严重性.
然而,由于这个主题几十年的混乱,以及太多数百万
不受Sun影响的开发人员,很容易将其称为同义词.
PEP开始于,
该PEP已被拒绝.虽然社区可能感兴趣,
但不希望使标准库符合此标准.
...
什么是Codetags？
程序员广泛使用特殊代码注释标记约定来作为需要仔细检查或审查的代码段的提醒.标记的例子包括
FIXME,TODO,XXX,BUG,但更多的被广泛使用于现有的软件.这样的标记此后将称为codetags.这些代码标签可能会出现在应用程序代码,单元测试,脚本,一般文档或适当的地方.
PEP是一本有趣的读物.
我使用,XXX因为它比键入更容易TODO.
XXX 是因为当你赶时间并且会自己回到这里.
TODO 当你必须把它交给别人时.
- @Randall:"引用"？对不起,这只是我在阅读了大量代码后的理解. (6认同)
- 哪些RFC是那些"文字含义"？或者还有其他任何引用吗？ (2认同)
| 归档时间： |
|
| 查看次数： |
46328 次 |
| 最近记录： |