The case against using single-line comments

Total article views: 162 | Views in the last 30 days: 9

 Rate this |   Join the discussion |  Briefcase

This isn't a "script" per se - but rather an observation about a common issue in writing scripts.

I want to alert SQL programmers to the issues surrounding the use of single-line comments.  I try to avoid these whenever possible, and use block comments instead (except, of course, when commenting out the keyword GO).

The reason is that, if a script is copied into a text editor that "wraps" lines, some single-line comments could be broken up into multiple lines.  If one were to copy that code from the editor into Query Analyzer and execute it, the result will be a syntax error, or in the worst case scenario, the execution of dangerous and unwanted code.

I've actually seen this happen with scripts submitted to SQLServerCentral.com.  The text box wherein scripts are pasted on this site "wraps" the text, and I've seen several where single-line comments were broken up into multiple lines.

Below, I have written a couple of examples to illustrate the importance of this:
 

Total article views: 162 | Views in the last 30 days: 9