Click to See Complete Forum and Search --> : Is It Crucial for a Developer to Use Doxygen when doing Projects in a Company?


f.ben.isaac
March 26th, 2009, 03:09 PM
I do not have experience in working with a group. However, i love to comment my code in a way that other developers can understand it, but i do not use such application, Doxygen. All my comments are inside the source code. Is there something wrong with this? or I have to use Doxygen? If apply for a job will they consider whether i used Doxygen or not?

Assuming the code is open source, i do not care who reads it...

What i believe: The rule of thumb is to make sure the reviewer should decipher it. Make sure you are writing code comments based onn "why-is-this?" rather than "what-it-is?".The comment should be precise. Fix me if i'm wrong

laserlight
March 26th, 2009, 03:51 PM
The point of Doxygen is to generate documentation in a form that is easier to read when someone wants to find out the relevant interfaces provided by your code. To that end, you would mark out your functions, classes, namespaces, etc with special comments so that relevant markup can be generated. It is not a substitute for appropriate comments deep inside the source code.

boudino
March 27th, 2009, 02:41 AM
It is not crucial, but it can helps others, so I'd say is a sign of coder's maturity.

f.ben.isaac
March 27th, 2009, 06:06 AM
Thanks...