Comment tags in JavaScript

Hi,

i have a task to clean up javascript / html comments from jsp code, preferably via regex.
I found something like this:

<script language="JavaScript">
                <!--
                openPopupDialog("xxx");
                // -->
</script>

And i'm unsure what this actually is. Is this something for old IE versions?

Thanks for you help
Fabian MaassAsked:
Who is Participating?

[Product update] Infrastructure Analysis Tool is now available with Business Accounts.Learn More

x
I wear a lot of hats...

"The solutions and answers provided on Experts Exchange have been extremely helpful to me over the last few years. I wear a lot of hats - Developer, Database Administrator, Help Desk, etc., so I know a lot of things but not a lot about one thing. Experts Exchange gives me answers from people who do know a lot about one thing, in a easy to use platform." -Todd S.

John EastonDirectorCommented:
As far as I know this is to support older browsers - i.e. one's which do not support the <script> tags.  Unless you are supporting very old clients it shouldn't be needed.
meb_santosoCommented:
HTML comments, ie. <!-- -->, are no longer needed. They were intended to allow (very old) browsers that didn't understand the <script> tag to degrade gracefully (see it as a fallback scenario).

These (very) old browsers are just like dinos, we practically can't find it anywhere, so frankly it's pointless to use the <!-- -->.
Do note that IF you explicitly still want to use comments before and after the javascript function, place double slashes before the closing comment tag:

<!--
blablablablabal
//-->

This prevents JavaScript from executing the --> tag.

...or use commented out CDATA tag:

<script type="text/javascript">
//<![CDATA[
document.write("Hello World!");
//]]>
</script>

Can you delete those <!-- --> lines? Go ahead, unless there are actual comments in there that is needed for debugging purposes.

Experts Exchange Solution brought to you by

Your issues matter to us.

Facing a tech roadblock? Get the help and guidance you need from experienced professionals who care. Ask your question anytime, anywhere, with no hassle.

Start your 7-day free trial
Terry WoodsIT GuruCommented:
If you're wanting help with the regex, you're probably best to ask that in a separate question. There is a "Regular Expressions" topic area that is well attended.
Fabian MaassAuthor Commented:
thank you all for your feedback.

so, to summarise:

1. using <!-- ... --> inside a javascript function was intended for old browsers, yet it is NOT a comment but the commands inside are evaluated
2. valid comments inside a javascript function should use the CDATA tag
3. the correct way to use html comments inside a javascript function would be <!-- //--> as the greater than sign will be evaluated otherwise

i think there is a misunderstanding on my part regarding the double slash. The answers say "HTML comments, ie. <!-- -->, are no longer needed.", yet i was not asking for tags " --> " but for " // --> ".

Please confirm my summary ;)

Thank you all
meb_santosoCommented:
Summary 1,2,3 are accurate.

Regarding the "// -->" : it's a mixed up world, between "I want to write (HTML) comments with the <script> </script> so I can humbrag about my functions that I copy-pasted from some other script" and "No, javascript, please ignore the dash-dash-greaterThan, just leave it alone".

It was a good practice back in the days where you want to do the above to think of a fallback scenario for the older browsers, but as JEaston also wrote, it's no longer needed.
It's more than this solution.Get answers and train to solve all your tech problems - anytime, anywhere.Try it for free Edge Out The Competitionfor your dream job with proven skills and certifications.Get started today Stand Outas the employee with proven skills.Start learning today for free Move Your Career Forwardwith certification training in the latest technologies.Start your trial today
HTML

From novice to tech pro — start learning today.