I came across the Natural Docs (http://www.naturaldocs.org/) project which takes a different approach to comment parsing. As .Net developers we have become accustomed to XML style comments such as <remark>Test method</remark>. Of course these kinds of comments are categorised nicely and easy to parse. Unfortunately I feel that the extra tags make the comments less readable. Of course the whole purpose of comments is that they should be read by other developers.
The Natural Docs project allows you to leave comments like this:
/*
Function: Multiply
Multiplies two integers and returns the result.
*/
public int Multiply (int x, int y) {
return x * y;
}
Natural Docs will then parse the code and produce an HTML file that looks like this:
