how do you document simulation of algorithms ?

Recommended Answers

All 7 Replies

Write your code and use plenty of remarks.

C# can create an XML document file using certain remark notations. I am not sure if any C++ compilers have that capability? Darn, I hate to be oblivious!

you can use javadoc notations in any program file written in any computer language. Not sure what program reads them and creates the html file. I had to make javadoc comments in my programs about a month or so ago, but I did not have to create the html files.

There is a tool 'oxygen' which generates the document from your C++ code. Provided you have sufficient remarks in it

Yeah you are right. I'm sorry, it should be Doxygen and not oxygen.

Be a part of the DaniWeb community

We're a friendly, industry-focused community of developers, IT pros, digital marketers, and technology enthusiasts meeting, networking, learning, and sharing knowledge.