Re: Documenting code in c++

Discussion in 'C++' started by Andre Kostur, Jun 30, 2003.

  1. Andre Kostur

    Andre Kostur Guest

    "Harbinger of Doom" <> wrote in
    news:iX0Ma.5804$-ops.be:

    > Hello,
    >
    > I was wondering how you can document code in C++ (if you can)
    > People who know Java around here probably know about the javadoc
    > utility. For the people who don't know Java, well, you can do
    > something like this:
    >
    > /**
    > * Adds two numbers
    > * @author someone
    > * @version 1.0
    > * @param a The first number of the addition
    > * @param b The second number of the addion
    > * @return the sum of a and b
    > */
    > public int Sum(int a, int b)
    > {
    > return a+b;
    > }
    >
    > And the the javadoc cool tool will create a html-page for you with
    > your documentation about the function Sum
    > This is very hand (especially when you're working on a large project,
    > or with different people on the same project)
    > I was wondering if it is possible to do that with C++,
    > My compiler is MS Visual C++ 6.0
    > I don't know if it supports documenting, but I can't seem to find
    > anything. In case it doesn't, does anyone know something about a third
    > party program that does that, or something like that?
    > thanks in advance!


    Take a look at Doc++...

    http://docpp.sourceforge.net/
    Andre Kostur, Jun 30, 2003
    #1
    1. Advertising

Want to reply to this thread or ask your own question?

It takes just 2 minutes to sign up (and it's free!). Just click the sign up button to choose a username and then you can ask your own questions on the forum.
Similar Threads
  1. Replies:
    0
    Views:
    610
  2. Replies:
    5
    Views:
    399
    Cedric LEMAIRE
    Sep 3, 2003
  3. Jeff Rodriguez

    Documenting C Code

    Jeff Rodriguez, Nov 18, 2003, in forum: C Programming
    Replies:
    17
    Views:
    903
    CBFalconer
    Nov 20, 2003
  4. Rony
    Replies:
    2
    Views:
    572
  5. Isaac Rodriguez

    Documenting Python code.

    Isaac Rodriguez, May 3, 2005, in forum: Python
    Replies:
    5
    Views:
    5,479
    Fredrik Lundh
    May 5, 2005
Loading...

Share This Page