Hi all

Just to contribute a little bit to the list, and because someone
mentioned about code comments (documentation).

I've been working with C for PIC for about a year. To me an important
issue is the reuse of code, and for that I need a well documented
code. Of course, all of you knows that. But also, I think sometimes it
is a little bit difficult to keep the code comments objective and
useful all the time.

My way to work around this was to use a tool for automatic generation
of documentation based on the code comments. The tool I am using is called
Doxygen (http://www.stack.nl/~dimitri/doxygen/). The results are very
good it generates documentation in a lot of formats, and the comment
tags are very easy to learn. The tool is also very flexible allowing
you to generate documentation for almost everything if you want.

Well, thats it I guess. If someone wants some help on that, feel free
to call me.

Rodrigo Real
Brasil


Kari Lehikko writes:
 >
 > As I have already decided what to do, this post is mostly posing about
 > my project :P

--
http://www.piclist.com hint: To leave the PICList
mailto:piclist-unsubscribe-request@mitvma.mit.edu