Web Wiz - Green Windows Web Hosting
Web Wiz Homepage Search Web Wiz

  New Posts New Posts RSS Feed - System Documentation
  FAQ FAQ  Forum Search   Events   Register Register  Login Login

System Documentation
 Post Reply Post Reply
Author
  Topic Search Topic Search  Topic Options Topic Options
ngaisteve1 View Drop Down
Groupie
Groupie
Avatar

Joined: 26 December 2002
Location: Malaysia
Status: Offline
Points: 169 		Post Options Post Options   Thanks (0) Thanks(0)   Quote ngaisteve1 Quote  Post ReplyReply Direct Link To This Post Topic: System Documentation
    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.
Back to Top
the boss View Drop Down
Senior Member
Senior Member
Avatar

Joined: 19 January 2003
Location: Saudi Arabia
Status: Offline
Points: 1727 		Post Options Post Options   Thanks (0) Thanks(0)   Quote the boss Quote  Post ReplyReply Direct Link To This Post 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
Back to Top
ultramods View Drop Down
Groupie
Groupie
Avatar

Joined: 08 January 2003
Location: Scotland
Status: Offline
Points: 146 		Post Options Post Options   Thanks (0) Thanks(0)   Quote ultramods Quote  Post ReplyReply Direct Link To This Post 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.
Back to Top
ngaisteve1 View Drop Down
Groupie
Groupie
Avatar

Joined: 26 December 2002
Location: Malaysia
Status: Offline
Points: 169 		Post Options Post Options   Thanks (0) Thanks(0)   Quote ngaisteve1 Quote  Post ReplyReply Direct Link To This Post 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!  
Back to Top
michael View Drop Down
Senior Member
Senior Member
Avatar

Joined: 08 April 2002
Location: United States
Status: Offline
Points: 4670 		Post Options Post Options   Thanks (0) Thanks(0)   Quote michael Quote  Post ReplyReply Direct Link To This Post 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.
Blog | MPG Tracker
Back to Top
 Post Reply Post Reply

Forum Jump Forum Permissions View Drop Down

Forum Software by Web Wiz Forums® version 12.08
Copyright ©2001-2026 Web Wiz Ltd.

Become a Fan on Facebook Follow us on X Connect with us on LinkedIn Web Wiz Blogs
About Web Wiz | Contact Web Wiz | Terms & Conditions | Cookies | Privacy Notice

Web Wiz is the trading name of Web Wiz Ltd. Company registration No. 05977755. Registered in England and Wales.
Registered office: Web Wiz Ltd, Unit 18, The Glenmore Centre, Fancy Road, Poole, Dorset, BH12 4FB, UK.

Prices exclude VAT at 20% unless otherwise stated. VAT No. GB988999105 - $, € prices shown as a guideline only.

Copyright ©2001-2026 Web Wiz Ltd. All rights reserved.