CodeGuru Home VC++ / MFC / C++ .NET / C# Visual Basic VB Forums Developer.com
Results 1 to 4 of 4
  1. #1
    Join Date
    Sep 2008
    Posts
    119

    Is It Crucial for a Developer to Use Doxygen when doing Projects in a Company?

    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

  2. #2
    Join Date
    Jan 2006
    Location
    Singapore
    Posts
    6,765

    Re: Is It Crucial for a Developer to Use Doxygen when doing Projects in a Company?

    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.
    C + C++ Compiler: MinGW port of GCC
    Build + Version Control System: SCons + Bazaar

    Look up a C/C++ Reference and learn How To Ask Questions The Smart Way
    Kindly rate my posts if you found them useful

  3. #3
    Join Date
    Mar 2004
    Location
    Prague, Czech Republic, EU
    Posts
    1,701

    Re: Is It Crucial for a Developer to Use Doxygen when doing Projects in a Company?

    It is not crucial, but it can helps others, so I'd say is a sign of coder's maturity.
    • Make it run.
    • Make it right.
    • Make it fast.

    Don't hesitate to rate my post.

  4. #4
    Join Date
    Sep 2008
    Posts
    119

    Re: Is It Crucial for a Developer to Use Doxygen when doing Projects in a Company?

    Thanks...

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  





Click Here to Expand Forum to Full Width

Featured