Irrlicht 引擎：代码注释约定？

Posted 2023-02-21

【中文标题】Irrlicht 引擎：代码注释约定？

【英文标题】：Irrlicht engine: code commenting convention?

【发布时间】：2011-12-27 14:09:21

【问题描述】：

我最近浏览了 Irrlicht 的 3D 游戏引擎源代码，我非常喜欢他们的评论风格。比如他们用/param指定函数参数，/intro做介绍等等。

看了几十个文件，我想知道这是自创的评论风格还是书本上的某种标准编码风格？

谢谢

【参考方案1】：

我认为 cmets 的编写风格是文档生成器的语法，例如 doxygen。

【讨论】：

是的，有时人们甚至在不使用文档生成器的情况下也会这样做，以获得统一的风格。

@user385261，看看 doxygen，它真的很棒。还有很多其他的。

对于那些认为自己无需实际编写文档就可以生成文档的人来说，这是一个很棒的工具。然后你会得到精彩的文档，它告诉你 setFoo(Foo) 是一个设置 foo 的函数，并且 Foo 参数是“要设置的 foo”。一定会喜欢它。

@jalf：为什么讨厌？它对于记录重要的代码很有用。

@BjörnPollex：是吗？ Documentation 对于记录重要的代码很有用。我只是不记得曾经见过 Doxygen 被用来生成真正的有用的文档。当然，理论上，没有什么能阻止你用它编写实际的文档，但在实践中，它几乎总是用来生成关于代码的琐碎和明显的事实，告诉你你不知道的任何事情