On 20/04/2011 22:53, Darren New wrote:

> I'm at a loss as to why such would be in comments in source code, but
> OK. :-)

Some people do advocate putting all your documentation inside your 
source code.

On the one hand, the idea is that the documentation is more likely to 
stay in sync with the source code. (E.g., if you swap the order of the 
arguments to a function, the documentation is right next to it, so you 
can update that as well.)

On the other hand, your source code is now littered with miles of text 
which have nothing to do with the compiler error you're now getting...

Post a reply to this message