How to write source code documentation?

This is a discussion on How to write source code documentation? within the C++ Programming forums, part of the General Programming Boards category; Hi all! I have a project where I have to write documentation for source code. As I have no experience ...

  1. #1
    Registered User
    Join Date
    Oct 2001
    Posts
    104

    Question How to write source code documentation?

    Hi all!

    I have a project where I have to write documentation for source code.
    As I have no experience in writing documentation, I wanted to ask you guys- does any of you have any experience with that, and what recommendations could you give? Eventually links to good articles about that?

    Thank you!

    Iliya Yordanov,
    www.csharp-home.com

  2. #2
    Skunkmeister Stoned_Coder's Avatar
    Join Date
    Aug 2001
    Posts
    2,572
    Doxygen is possibly a good starting point.
    Free the weed!! Class B to class C is not good enough!!
    And the FAQ is here :- http://faq.cprogramming.com/cgi-bin/smartfaq.cgi

  3. #3
    Hardware Engineer
    Join Date
    Sep 2001
    Posts
    1,398
    There are many different answers to your question.

    Ask the person who gave you the "assignment" for more details... maybe you can get an example. Since apparently they didn't give you any specifics, I suspect they have no formal documentation standards. A few flow charts and some psudo code (or other text) may be adequate.

    Some orginizations have very strict documentation formats and standards. You might assemble a very complete documentation package, but it won't be accepeted if it does not conform. At the small company where I work, it's very loose... whatever the programmer wants to do. (We are not a "software" company.)

Popular pages Recent additions subscribe to a feed

Similar Threads

  1. Need software to help to understand C source code
    By Kincider in forum C++ Programming
    Replies: 1
    Last Post: 09-28-2006, 09:44 PM
  2. Source code....
    By Darkcoder in forum Game Programming
    Replies: 8
    Last Post: 03-07-2005, 07:58 PM
  3. True ASM vs. Fake ASM ????
    By DavidP in forum A Brief History of Cprogramming.com
    Replies: 7
    Last Post: 04-02-2003, 03:28 AM
  4. Source Code Beautifier
    By Hammer in forum A Brief History of Cprogramming.com
    Replies: 2
    Last Post: 05-05-2002, 09:21 PM
  5. Source Code Needed!
    By spongleman in forum C++ Programming
    Replies: 1
    Last Post: 01-02-2002, 07:14 PM

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21