MonitorWare Knowledge Base

Folks,

I expect that we will get quite a bit of development doc in the next weeks. I think about diagrams and text. Question now: how to handle them? Use HTML? Works well with version control, but is somewhat limited. Use a wiki? Needs one and I think is not really good with version control, but has great ability to easily add/change content.

Or embed everything in code comments? If so, how to handle the graphics?

Feedback appreciated,
Rainer

I prefer inline code comments using doxygen or phpdoc to create the documentation. Not sure how to handle associated external diagrams but probably a simply link will do the trick.

Michael

If it is possible in PHP to use doxygen, I prefer that one too. It's easier to have documentation done ONCE in the code instead of multiple times.

I have used doxygen in the past and find it quite useful. To me, this route sounds good. We should try it out tand then make the final decision.

Rainer