Irrlicht引擎:代码评论惯例?

use*_*261 3 c++ coding-style

我最近一直在浏览Irrlicht的3D游戏引擎源代码,我非常喜欢他们的评论风格.例如,它们用于/param指定函数参数和/intro引入等.

在阅读了十几个文件之后,我想知道这是自创的评论风格还是书中可以找到的某种标准编码风格?

谢谢

nea*_*gab 7

我认为注释是以文档生成器的语法编写的,例如doxygen.

  • 对于那些认为可以在不实际编写文档的情况下生成文档的人来说,这是一个很棒的工具 然后你会得到一些精彩的文档,告诉你`setFoo(Foo)`是一个设置foo的函数,而且'Foo`参数是"要设置的foo".一定要喜欢它. (5认同)
  • @jalf:为什么讨厌?它对于记录非平凡代码很有用. (2认同)