Re:Literate CoffeeScript
by crazygringo on Monday February 25, 2013 @08:08PM
(#5283152)
Comments also function as a SUMMARY of what the code does.
A file should always have a summary at the top. A function more than a couple lines long should always have a summary explaining what it does.
In the real world, people don't have time to read your 5,000 lines of code -- they need to be able to jump in, make a change, and not break things. Comments are very important for this.
A file should always have a summary at the top. A function more than a couple lines long should always have a summary explaining what it does.
In the real world, people don't have time to read your 5,000 lines of code -- they need to be able to jump in, make a change, and not break things. Comments are very important for this.