System Documentation
Printed From: Web Wiz Forums
Category: General Discussion
Forum Name: General Discussion
Forum Description: General discussion and chat on any topic.
URL: https://forums.webwiz.net/forum_posts.asp?TID=3945
Printed Date: 29 March 2026 at 2:53pm
Software Version: Web Wiz Forums 12.08 - https://www.webwizforums.com
Topic: System Documentation
Posted By: ngaisteve1
Subject: System Documentation
Date Posted: 30 June 2003 at 1:11am
| Not sure where to post this. It's about documentation. I have a dilemma here about documentation. I realize that as my system become more and more complicated, there is a need of documentation to help me to remember the logic of the code. I do not know what is the proper method of documentation. Should I put comment as part of documentation in the code? If got lots of comment, it will increase the file size. Another problem is if the system frequently changed it's requirement, then the documentation will has hard time to follow, isn't? This is my first time handling the whole sdlc of a system. Thus, do not have the experience. Thanks for all advice in advance. |
Replies:
Posted By: the boss
Date Posted: 30 June 2003 at 1:23am
|
use shor comment or just give a comment number instead of a comment and mantain a hand book in which u write down the corresponding comment / description for each comment number.. this is more organised as for eg: all recordsets will have the same comment number so u know that all recorsets with folloing comment number r for the following purpose rather than writting each time: ' recordset to query user table |
Posted By: ultramods
Date Posted: 30 June 2003 at 2:01am
|
I use separators, in all my pages, for example '**************GET LATEST NEWS************** 'sub comment news code here '**************END GET LATEST NEWS***********
'**************DISPLAY NEWS************** 'sub comment Display news code here '**************END DISPLAY NEWS************ I find this way very usefull when looking back at a page that were completed a while in the past. Comments will make your file size larger, but wont really make processing longer as the server should ignore them. |
Posted By: ngaisteve1
Date Posted: 30 June 2003 at 2:22am
|
"Comments will make your file size larger, but wont really make processing longer as the server should ignore them." I like this point, ultramods and also boss' point about using no for same comment. Good points! |
Posted By: michael
Date Posted: 30 June 2003 at 8:47am
|
Though comments are for making it easy to know what is going on in the code etc. If you have to look in a book it makes it harder again. I found, unless you write an essay the size increase does not matter. Sure they matter on the server but do not get processed. I am doing it similar to the way ultramods does which helps a lot when debugging code. ------------- http://baumannphoto.com" rel="nofollow - Blog | http://mpgtracker.com" rel="nofollow - MPG Tracker |