Email: Password: Remember Me | Create Account (Free)

Back to Subject List

Old thread has been locked -- no new posts accepted in this thread
???
09/07/01 21:35
Read: times


 
#14818 - RE: Coments field ( ;)
They are not necessary to write a program, but you will very soon discover just how essential they are to maintain the program

Yes, They should clarify the action of the section of code;
There is no point in simply commenting the function of, say, the ADD instruction - that can simply be found from the data sheet.
It might be worth commenting if you rely on some obscure side-effect, but generally your comments should explain things like the reason for needing to do the particular addition at this particular point

Variable definitions should be commented to say what the variable means; eg what units does the value represent?
There's a famous case of a NASA space probe which was lost because one part of the software assumed a variable was in inches, but another assumed millimetres!

List of 21 messages in thread
TopicAuthorDate
Coments field ( ;)            01/01/70 00:00      
RE: Coments field ( ;)            01/01/70 00:00      
RE: Coments field ( ;)            01/01/70 00:00      
RE: Coments field ( ;)            01/01/70 00:00      
RE: Coments field ( ;)            01/01/70 00:00      
RE: Coments field ( ;)            01/01/70 00:00      
RE: Coments field ( ;), Kathy            01/01/70 00:00      
RE: Coments field ( ;) - Kathy            01/01/70 00:00      
RE: Coments field ( ;)            01/01/70 00:00      
No Never Comment !!            01/01/70 00:00      
RE: Coments field ( ;) - Kathy            01/01/70 00:00      
RE: Still Off_Base - Kathy            01/01/70 00:00      
RE: Coments field ( ;) - Kathy            01/01/70 00:00      
RE: Coments field ( ;) - Bordyn            01/01/70 00:00      
RE: Coments field ( ;)            01/01/70 00:00      
RE: Coments field ( ;),Alfredo            01/01/70 00:00      
RE: Coments field ( ;),Gil            01/01/70 00:00      
RE: Coments field ( ;),Bordyn            01/01/70 00:00      
RE: Coments field ( ;),Bordyn            01/01/70 00:00      
RE: Coments field ( ;),Andy            01/01/70 00:00      
RE: Coments field ( ;),Andy            01/01/70 00:00      

Back to Subject List