user385261
user385261

Reputation: 4169

Irrlicht engine: code commenting convention?

I've recently been skimming through Irrlicht's 3D game engine source code, and I really like their commenting styles. For example, they use /param to specify function parameters, and /intro for introduction and so on.

After reading over dozen of files, I was wondering if this is self-created commenting style or some kind of standard coding style that be found in books?

thanks

Upvotes: 3

Views: 195

Answers (1)

joy
joy

Reputation: 1569

I think the comments are written in a style that is a syntax for a documentation generator, such as doxygen.

Upvotes: 7

Related Questions