How to Annotate in HTML

Commenting on the code will allow you to leave reminders and explanations for yourself and other programmers while working on the site. Comments can also be used to disable code snippets when you’re testing or working on a new feature that’s still incomplete. Learning how to annotate properly will make programming more productive for you and your colleagues.

Table of Contents

Steps

{“smallUrl”:”https://www.wikihow.com/images_en/thumb/f/f5/795094-1.jpg/v4-460px-795094-1.jpg”,”bigUrl”:”https:// www.wikihow.com/images/thumb/f/f5/795094-1.jpg/v4-728px-795094-1.jpg”,”smallWidth”:460,”smallHeight”:258,”bigWidth”:728,” bigHeight”:409,”licensing”:”<div class=”mw-parser-output”></div>”}

Insert a comment line. Comments are specified by  tags. You can quickly insert a comment to remind yourself of the problem with the code.

 < html > < head > < title > Test Caption </ title > </ head > < body > <!-- This code generates a paragraph --> < p > This is a website </ p > < / body > </ html >

You need to make sure there is no space between the caption tag. For example, the < !-- tag cannot enable commenting. Inside the caption tag, you can add as much spacing as you want.

{“smallUrl”:”https://www.wikihow.com/images_en/thumb/6/6d/795094-2.jpg/v4-460px-795094-2.jpg”,”bigUrl”:”https:// www.wikihow.com/images/thumb/6/6d/795094-2.jpg/v4-728px-795094-2.jpg”,”smallWidth”:460,”smallHeight”:258,”bigWidth”:728,” bigHeight”:409,”licensing”:”<div class=”mw-parser-output”></div>”}

Create multiple lines of comments. Your notes can span multiple lines, which is great for explaining complex code or disabling large chunks of code.

 < html > < head > < title > Caption Experiment </ title > </ head > < body > <!-- Captions can be as long as you want. Anything inside the tag has no effect on the code on the web page. --> < p > This is website </ p > </ body > </ html >

{“smallUrl”:”https://www.wikihow.com/images_en/thumb/b/ba/795094-3.jpg/v4-460px-795094-3.jpg”,”bigUrl”:”https:// www.wikihow.com/images/thumb/b/ba/795094-3.jpg/v4-728px-795094-3.jpg”,”smallWidth”:460,”smallHeight”:259,”bigWidth”:728,” bigHeight”:410,”licensing”:”<div class=”mw-parser-output”></div>”}

Use comments to quickly disable a piece of code. If you’re looking for errors or want to prevent code from continuing to run on your site, you can use the comment feature to quickly block the code. Thus, you only need to remove the comment tag and you can easily restore the code.

 < html > < head > < title > Caption testing </ title > </ head > < body > < p > View this message </ p > < img src = "/images/image1.jpg" > <! -- Hide this image now <img src="/images/image2.jpg"> --> </ body > </ html >

{“smallUrl”:”https://www.wikihow.com/images_en/thumb/6/6e/795094-4.jpg/v4-460px-795094-4.jpg”,”bigUrl”:”https:// www.wikihow.com/images/thumb/6/6e/795094-4.jpg/v4-728px-795094-4.jpg”,”smallWidth”:460,”smallHeight”:259,”bigWidth”:728,” bigHeight”:410,”licensing”:”<div class=”mw-parser-output”></div>”}

Use comments to hide scripts on browsers that don’t support Java. If you’re programming in JavaScript or VBScript, you can use the comment feature to hide the script on browsers that don’t support it. At the beginning of the script, insert a comment and end it with the //--> tag to ensure that the script only works on supported browsers.

 < html > < head > < title > VBScript </ title > </ head > < body > < script language = "vbscript" type = "text/vbscript" > <!-- document . write ( "Hello World!" ) //--> </ script > </ body > </ html >

^{[1] X Research Source}

The // at the end of the tag will prevent the script from executing the comment feature if it is supported by the browser.

Advice

Annotating is a good habit in programming because it helps you remember how things work and will be easier for you to come back to code later.

Steps

Advice

Related Posts