#XXX是什么意思?
我已经看到了很多代码,甚至vim标志着这是一个特例。 #TODO
和#FIXME
是两个其他固定标记vim高亮,但是#XXX
是什么意思?
XXX
中的评论通常是单挑。 它可能是:
- 有些东西没有完全正确地实施。
- 稍后应该修复的东西。
- 突出显示可能的问题点。
- 一些你不确定的事情,一个问题。
我经常更喜欢一个更像FIXME
或TODO
或HACK
描述性标签。 XXX
经常被用来作为上述的一切。
在FreeBSD代码交叉引用中search'XXX'是许多用途的一个很好的例子。 有几千…
-
NOTE
:描述代码如何工作(当它不是自明的时候)。 -
XXX
:关于可能的陷阱的警告,可以用作NOTE:XXX:
-
HACK
:编写得不好或者代码格式不正确以避免问题/ bug。 应该用作HACK:FIXME:
-
FIXME
:这种方式有效,但可以做得更好。 (通常代码写得很急,需要重写)。 -
BUG
:这里有一个问题。 -
TODO
:没问题,但是需要编写附加代码,通常是在跳过某些内容时。
至less这是我如何教这些标签。 基本上前两个( NOTE
和XXX
)用于信息,不需要任何操作。 而最后三个( FIXME
, BUG
和TODO
)确实需要采取行动。 HACK
在两者之间(几乎没有用过,我想?)。
从2005年6月Python增强build议中的一些注释被拒绝 。
在
FIXME
和XXX
之间select是困难的。
XXX
似乎更常见,但更不具描述性。
而且,XXX
在一段代码中是一个有用的占位符
具有未知的价值。因此
FIXME
是首选的拼写。
Sun说XXX
和FIXME
略有不同,给XXX
更高的严重程度。
但是,这个话题几十年来一直都是混乱的,而且数以百万计
那些不受Sun影响的开发者,很容易把他们称为同义词。
PEP从开始,
这个PEP被拒绝了。 虽然社区可能有兴趣,
不希望使标准库符合这个标准。
…
什么是Codetags?
程序员广泛使用临时代码注释标记约定来提醒需要仔细检查或检查的代码段。 标记的例子包括
FIXME
,TODO
,XXX
,BUG
,但在现有的软件中有更多的广泛使用。 此类标记从此将被称为代码标签 。 这些代码标签可能出现在应用程序代码,unit testing,脚本,一般文档或任何合适的地方。
PEP是一个有趣的阅读。
我使用XXX
因为比TODO
更容易input。
XXX
是为了当你急着,会自己回来。
TODO
是当你不得不把它交给别人的时候。
看看PEP350 。 它解释了所有的TODO
, XXX
等。我每天都使用它,当我不记得代码标签是什么意思。
可能是因为你不知道如何处理的情况。
看看这个: TODO / FIXME / XXX / HACK语句的列表视图
替代文字http://editra-plugins.googlecode.com/svn/wikihttp://img.dovov.comcommentbrowser/cb_screenshot.PNG
一个占位符,通常意味着它所指的代码是:
- 丑陋
- 害怕
- 魔法
或更糟。
从(旧) Java代码约定 :
在评论中使用XXX标记是虚假的,但工作。 使用FIXME来标记一些虚假的东西。
XXX是与NOTE略有不同的警告,但与HACK非常相似。 这可能是正在使用的第三方库/代码中的错误,并且// XXX:的代码表示由于第三方代码中的错误而导致的解决方法,或者对于正在查看/修改的用户可能会“谨慎”代码来说明为什么某些事情是以某种方式完成的,否则在第一眼看来可能看起来不正确/不合适。 HACK是通用术语,意思是可以存在于您自己的代码库或第三方库中的问题的解决方法。
我相信,虽然FIXME
是为开发人员,而HACK
是为维护者, XXX
是为用户。
例如,如果你忽略了XXX
并在其他地方调用这个函数,而不理解它是如何工作的,那么可能会发生意想不到的事情,并且处理这个问题的人将会不高兴(至less添加了XXX
是这么认为的)。 如果你不使用这个function,你可能会认为这个问题将会消失。
但是对于FIXME
,你会觉得值得修正代码来使其工作。 而对于HACK
,即使你不使用它,也可能没有更好的select。
如果您在自己的代码中写了XXX
,并且有人使用了它,那么您可能会因为像您完全重写该代码这样的原因而感到不快,而且它的行为方式完全不同,并且破坏了别人的代码。 但是,如果你离开了一个FIXME
或TODO
,你将不会在意这么多。