How to write documentation comments in ANSI C?

c documentation code-documentation
bb2 picture bb2 · Jan 17, 2012 · Viewed 14.5k times · Source

I can't find how to write comments in C. I mean I know about // and /* */, what I mean is where can I find good practices? Like if I have a function, how do I write the @param variable is the value bla bla, like it is done in Java?

Are there any standards for this? Or can I just do it like I do it in Java?

Answer

Dhaivat Pandya picture Dhaivat Pandya · Jan 17, 2012

There are many different standards, if you want to generate documentation, try doxygen

Related questions

FFmpeg C API documentation/tutorial

I am trying to find documentation to use the FFmpeg C API. It seems that only command line documentation is available. Is there any good documentation/tutorials/links available?

Read More
A doxygen eclipse plugIn automatically generating stub documentation?

I'am looking for an eclipse-plugin for doxygen code documentation. I have found the eclox-plugIn ( http://home.gna.org/eclox/ ). I would like find out, how can it automatically generate a "empty" doxygen comment, which could be filled out later or …

Read More
Is there something like the official C documentation?

I'm looking for the documentation of all the syntax and built-in functions in C, but I can't find any site online which seems like an ultimate official source of standard C knowledge. Apart from the famous book by Kernighan and …

Read More