Commenting an existing application

Results 1 to 2 of 2

Thread: Commenting an existing application

  1. #1
    Join Date
    Dec 1969

    Default Commenting an existing application

    I am working on a rather large ASP application that currently contains has very few comments and has almost no documentation. Can anyone suggest how I might go about adding comments and developing documentation? Are there any good tools to assist in this?<BR><BR>TIA,<BR>Sven

  2. #2
    Join Date
    Dec 1969

    Default RE: Commenting an existing application

    I don&#039t know of any tools that do it for you but I tend to have a document that contains a hierarchy diagram of the web pages and then for each page I write a description of what the page does, I list any session variables used and where possible a description of what parameters each page requires to fulfill the functionality for that page (i.e. if the page requires an id no, a session variable, etc.. then I have a record of this).<BR><BR>I try to avoid writing too many comments into the code itself because each line is read before being parsed to HTML, I believe this slows the process down, but then how much can it really slow it down?

Posting Permissions

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