Irrlicht引擎：代码注释约定？

Question

我最近研究了Irrlicht的3D游戏引擎源代码，我非常喜欢他们的注释风格。例如，他们使用/param 来指定函数参数，/intro用于介绍等等。

读过几十个文件后，我想知道这是自创的注释风格还是可以在书籍中找到的某种标准编码风格？

谢谢

- user385261

Answer 1

我认为这些评论的风格是文档生成器的语法，比如doxygen。

- joy

---

这是一个非常好用的工具，适合那些认为可以在不实际编写文档的情况下生成文档的人。然后你就会得到精美的文档，告诉你 setFoo(Foo) 是一个设置 foo 的函数，并且 Foo 参数是“要设置的 foo”。真是太棒了。 - jalf

@jalf：为什么这么讨厌呢？它对于记录非平凡代码非常有用。 - Björn Pollex

@BjörnPollex：是吗？文档对于记录非平凡代码非常有用。我只是不记得曾经看到过Doxygen被用来生成真正有用的文档。当然，从理论上讲，你可以用它来编写实际的文档，但在实践中，它几乎总是用于生成关于代码的琐碎和显而易见的事实，这些事实告诉你没有你不知道的东西。 - jalf

@jalf：我认为它非常适合解释参数、返回值和其他细节方面。然而，我认为如何操作和整体框架的解释必须手动完成。 - user385261

@user385261：同意。但我认为问题在于（1）人们一旦使用Doxygen就倾向于跳过第二部分（手写解释），以及（2）如果您的参数和函数命名正确，这些东西根本不需要太多/任何解释。但只要记住第二部分，那就是最重要的。 :) - jalf