什么是#XXX的代码中的注释的含义?(What is the meaning of #XXX in

2019-07-18 17:38发布

我看到这个有很多代码,甚至VIM将其标记为一个特殊情况。 #TODO#FIXME另外两个固定标记Vim高亮但到底是什么#XXX是什么意思?

Answer 1:

XXX在评论通常是单挑。 它可能是:

  • 东西是不是完全正确实施。
  • 东西应该在后面固定。
  • 突出一个可能出现问题的地方。
  • 有些事情,你是不知道,一问。

我常常首选就像一个更具描述性标签FIXMETODOHACKXXX经常被用来作为一个包罗万象的用于上述。

在搜索上的“XXX” 的FreeBSD代码交叉引用是许多用途中的一个很好的例子。 有成千上万的...



Answer 2:

  • NOTE :的代码是如何工作(当它是不言自明)说明。
  • XXX :警告有关可能存在的缺陷,可以用作NOTE:XXX:
  • HACK :不太好书面或恶意代码,以规避问题/错误。 应作为HACK:FIXME:
  • FIXME :这工作,排序的,但它可以做的更好。 (通常编写的代码中,需要重写着急)。
  • BUG :这里有一个问题。
  • TODO :没问题,但addtional代码需要编写,通常当你跳过一些东西。

至少这是我是如何教这些标签。 基本上的前两个( NOTEXXX )被用于信息和不需要的动作。 虽然过去三年( FIXMEBUGTODO )确实需要采取行动。 HACK则介于两者之间(和很少使用,我认为?)。



Answer 3:

从一些注意事项是被拒绝了2005年6月的Python增强提案 。

之间进行选择FIXMEXXX是困难的。
XXX似乎更为常见,但要少得多描述。
此外, XXX是在一块代码的有用的占位符
具有的值是未知的。

因此FIXME是优选的拼写。
孙说, XXXFIXME略有不同,给人XXX更高的严重程度。
然而,几十年混乱的这个话题,太多数百万
谁也不会受阳光影响的开发商,很容易正确地调用它们的同义词。


该PEP开始用,

这PEP已被拒绝。 虽然社区可能也有兴趣,
没有欲望,使标准库符合这一标准。

...

什么是Codetags?

程序员广泛使用特殊的代码注释标记约定需要更仔细的检查或审查,以服务为代码段的提醒。 标记的例子包括FIXMETODOXXXBUG ,但还有更多的在现有的软件广泛使用。 这样的标记此后将称为codetags。 这些codetags可以在应用程序代码中,单元测试脚本,一般文档,或任何合适的显示。


该PEP是一个有趣的阅读。



Answer 4:

看一看PEP350 。 它解释了所有的TODOXXX等我用它每天当我不记得确切的代码标记手段之一。



Answer 5:

我用XXX因为它更容易,而不是键入TODO

XXX是当你在赶时间,将回到这个自己。

TODO是当你必须将它交给别人。



Answer 6:

也许它是你不知道如何处理案件。
看看这个: TODO的列表视图/ FIXME / XXX / HACK声明

替代文字http://editra-plugins.googlecode.com/svn/wiki/images/commentbrowser/cb_screenshot.PNG



Answer 7:

一个占位符,通常意味着它指的是代码:

  • 丑陋
  • 害怕
  • 魔法

或者更糟。



Answer 8:

从(旧) 的Java代码约定 :

中旗的东西是假的,但工程的注释中使用XXX。 使用FIXME来标识的东西是假的,并打破了。



Answer 9:

XXX是短期的警告是从注略有不同,但颇为相似的黑客行为。 这可能是在正在使用第三方库/代码中的错误并通过// XXX代码:表示要么是解决办法由于第三方代码中的错误,也可能意味着“小心”,以找人/修改代码来说明为什么东西,否则可能看起来不正确/不雅在第一次看某种方式完成。 HACK是通用术语,意为可能出现在无论是你自己的代码库或第三方库的问题的解决方法。



Answer 10:

我相信,而FIXME是为开发者和HACK是维护者, XXX是用户。

例如,如果你忽视了XXX和其他地方调用这个函数,不理解它是如何工作的,意想不到的事情可能发生,处理这个问题的人会不高兴(至少谁添加了一个XXX是这样认为的)。 你可能会认为,如果你不使用此功能的问题将不复存在。

但对于FIXME ,你会觉得值得刚修好的代码,使其工作。 而对于HACK ,你可能没有更好的选择,即使你不使用它。

如果你写XXX在你自己的代码,有人用它,你可能会觉得不开心的原因就像你完全重写的代码,然后把它表现在完全不同的方式,你打破了别人的代码。 但是,如果你留下了FIXMETODO相反,你不会在乎那么多。



文章来源: What is the meaning of #XXX in code comments?
标签: comments