Home > C++ > C++ source code documenting

C++ source code documenting

I have been searching the web for a documenting program for C++ codes. A program that I can write documentation of the code separated from the source code file. But I couldn’t find anything good or worth it. I have currently written a huge program in C++ and I’m finding some difficulties to keep tracking my codes so I was looking for a separated documenting program. If anyone knows a good program, please let me know by emailing me or posting a comment.

Anyway, I run across a webpage that explains guidelines to document a source code written in C++ and I’d like to share it. Here is the link. I also found phpDocumentation which I posted in this blog.

Documenting my codes

It is so frustrating to write documentation for my C++ codes in Microsoft Word especially when the source code contains over 4300 lines of code! and that considered to be a small program!

So if anyone knows a good program for documenting source codes for c++, please let me know by emailing me or posting a comment.

Categories: C++ Tags:
  1. marcoow
    July 10th, 2007 at 19:23 | #1

    If you are interested in source code documentation and use Visual Studio 2005, you might as well like .Net Documentor. .Net Documentor is an Add-in for Visual Studio 2005 that adds distinct productivity features to the IDE’s source code documentation capabilities such as:

    – Recursive documentation of all code elements in a project. (with optional insertion of task shortcuts to all documentation comments that require manual input)
    – Recursive documentation of a type and all of its members
    – Documentation at either Declaration or Definition for C++ code
    – Automatic application of custom text snippets to constructors, properties and events
    – Inheritance of the base type’s documentation for overridden members or members that implement interfaces
    – Application of references to all base types and implemented interfaces of the documented type.

    .Net Documentor support C#, VB and C++, C++/CLI and is available here: http://formpage.de/net-documentor

  1. No trackbacks yet.