Scripter Javascript Tutorial

81 Explanations

Explanations about what a function or code block does are the most common and valuable comments. Like the preamble to this section stated, good explanations should just explain the intent of the code and not be a line-by-line explanation. This keeps the comment low maintenance and all creativity in the code itself. There are times when a line or block of code is both convoluted and critical to a script, so a line-by-line explanation is useful, but that should be rare.