source code comments/documentation

Forum 2005-2010 (read only) Software Development
1

I don't want to start a long philosophical discussion here. Is there a preferred method of source code documentation in the Arduino community?

A link to an example documented source code you like is all I need.

Thanks,
Curt

2

Standard C++ comments. /* ... */ For documentation blocks (what a function or program does), // for inline comments. Some people like I prefer not to use training // at the end of the line, other do it. It's a matter of taste.

Korman

3

If you want to do it right:

http://www.stack.nl/~dimitri/doxygen/

:wink:

4

Or RoboDoc (open source)
http://www.xs4all.nl/~rfsber/Robo/robodoc.html

I like RoboDoc, its smaller and faster than doxygen, and not nearly as complicated. Of course it doesn't reverse engineer by scanning functions either.