Slashdot Mirror

← Back to Stories (view on slashdot.org)

Generating API Documentation?

Posted by Cliff on from the ease-the-trials-of-documentation dept.

Preda asks: "I have been recently tasked with generating API documentation for new and legacy code. Given the amount of legacy code (in C, VB6, VB.NET, PHP, and other languages) and new code that needs to be documented, are there any easy auto generating API programs out there. I have done a few searches but nothing that I have found stood out as a 'use me' solution. Does anyone have any advice?"

2 of 54 comments (clear)

  1. Do you really want to suceed at this? by EraserMouseMan · · Score: 3, Funny

    I have been recently tasked with generating API documentation for new and legacy code.

    This is usually what a company asks an important developer to do before they let him/her go. I hope this isn't your situation though. Hopefully they are promoting you to manager and letting you hire/train new employees (using your documented code).

  2. Commentator by RAMMS+EIN · · Score: 4, Funny

    Commentator. Because you _know_ the coders haven't properly commented their code.

    --
    Please correct me if I got my facts wrong.