Using comments in script link tag

Question

What problems can be caused by placing comments in a script tag calling an external script? My coworker told me this is not a good practice.

Something like this:

<script src="http://jqueryjs.googlecode.com/files/jquery-1.2.6.min.js" type="text/javascript">
            //    import jQuery
            //    cdn refers to a remotely hosted library
</script>

score 3 · Answer 1 · answered May 09 '12 at 23:56

3

Nothing wrong, maybe readability. The content will also be overwritten by the source.

<!-- import jQuery. CDN refers to a remotely hosted library -->
<script src="http://jqueryjs.googlecode.com/files/jquery-1.2.6.min.js" type="text/javascript"></script>

answered May 09 '12 at 23:56

Etienne Dupuis

13,548
6
47
58

score 3 · Answer 2 · edited May 23 '17 at 10:09

3

No problems at all. If the script element has a src attribute, the content is ignored.

Maybe your coworker was referring to HTML comments inside the script tag, which where used for ancient browsers which did not support JavaScript?

<script>
   <!--
      // JS was here
   // -->
</script>

Are HTML comments inside script tags a best practice?

edited May 23 '17 at 10:09

Community

1
1

answered May 09 '12 at 23:56

Felix Kling

795,719
175
1,089
1,143

score 1 · Accepted Answer · answered May 10 '12 at 02:43

Maybe your coworker is concerned you'll get in the habit of doing this

<script src="http://jqueryjs.googlecode.com/files/jquery-1.2.6.min.js" type="text/javascript">
            //    import jQuery
            //    cdn refers to a remotely hosted library
</script>

And then eventually struggle to figure out why this doesn't work

<script src="http://jqueryjs.googlecode.com/files/jquery-1.2.6.min.js" type="text/javascript">
     $(document).ready(function() {
           $('#ActionButton').click(DoAction);
     });
</script>

Because you've developed a bad habit

Using comments in script link tag

3 Answers3