I comment my code. I've been working on some of the same code for over
20 years. Early on I commented the code where it is not clear what the
code does. I also put comments in like, "* this needs to be
refactored" Since I work on payroll for companies, when someone tells
me to make a change I comment who authorized it and what date the change
was made.
The most amazing example of documentation is the Visual Maxframe
framework. Drew Speedie's zreadme() method gives you everything you
need to use a class. He also commented code in hook methods with
example code that you could uncomment and use in the method. Also, when
he used a line of code that maked no sense at all, he would tell you why
he did it and what it does.
It's all that documentation and comments that made it possible to get up
to speed quickly to using that framework.
For those that have used a framework, imagine what it would be like
without the documentation. That's what you get when you use refox!
Jeff
---------------
Jeff Johnson
j...@san-dc.com
(623) 582-0323
www.san-dc.com
www.arelationshipmanager.com
On 10/30/2013 12:47 PM, Stephen Russell wrote:
http://visualstudiomagazine.com/articles/2013/06/01/roc-rocks.aspx
Article is Why You Shouldn't Comment (or Document) Code
_______________________________________________
Post Messages to: ProFox@leafe.com
Subscription Maintenance: http://mail.leafe.com/mailman/listinfo/profox
OT-free version of this list: http://mail.leafe.com/mailman/listinfo/profoxtech
Searchable Archive: http://leafe.com/archives/search/profox
This message: http://leafe.com/archives/byMID/profox/527257a8.8030...@san-dc.com
** All postings, unless explicitly stated otherwise, are the opinions of the
author, and do not constitute legal or medical advice. This statement is added
to the messages for those lawyers who are too stupid to see the obvious.
