TIP: Click on subject to list as thread! ANSI
echo: os2prog
to: Craig Swanson
from: Brian Converse
date: 1994-12-17 14:22:08
subject: Code quality

CS> all the source code had 
CS> been written by programmers who appeared to have the idea 
CS> that comments were for identifying who wrote the code and 
CS> to put arbitrary version numbers on each file.  Obviously 
CS> knowing that a file had been at version 0.2, and then 0.21, 
CS> and then 0.25 is really useful information.  But comments 
CS> shouldn't be used for anything else. Certainly noting what 
CS> each function does should not be done, and identifying the 
CS> purpose of parameters and variables is obviously heresy.  
CS> It left me wondering why they stooped to occasionally use 
CS> intelligible variable names -- why not just put everything 
CS> in some cipher code.

The C Set ICLUI samples are my idea of well-commented code.
Just cycled thru all 6 to make sure LINK386 works now. The
READMEs as a global comment are nice, too. I'm not big on the
version lineage and commented mod. lines, but that is a unique
requirement of the tutorial aspect of the IBM code.

___
 X KWQ/2 1.2e X Dr. Schrodinger! It's the humane society...

--- Maximus/2 2.02
* Origin: OS/2 Shareware BBS, Fairfax, VA: 703-385-4325 (1:109/347)
SEEN-BY: 12/2442 620/243 624/50 632/348 640/820 690/660 711/409 410 413 430
SEEN-BY: 711/807 808 809 934 942 949 712/353 515 713/888 800/1
@PATH: 109/347 2 7 3615/50 229/2 12/2442 711/409 808 809 934

SOURCE: echomail via fidonet.ozzmosis.com

Email questions or comments to sysop@ipingthereforeiam.com
All parts of this website painstakingly hand-crafted in the U.S.A.!
IPTIA BBS/MUD/Terminal/Game Server List, © 2025 IPTIA Consulting™.