greatbody
/
freeCodeCamp
mirror of https://github.com/freeCodeCamp/freeCodeCamp.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Correct grammar and make more concise (#35179) 

* Correct Grammar and make more concise

* Improve readability
pull/36297/head
Jonathan Lawrence 2019-06-02 05:04:07 -04:00 committed by Parth Parth
parent 40386890ed
commit 56f45c38a9
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
guide/english/html/comments-in-html/index.md
View File

@ -6,14 +6,14 @@ title: Comments in HTML
The comment tag is an element used to leave notes, mostly related to the project or the website. This tag is frequently used to explain something in the code or leave some recommendations about the project. The comment tag also makes it easier for the developer to come back at a later stage and understand the code he's written earlier. Comments can also be used for commenting out lines of code for debugging purposes.
It is good practice to add comments to your code, especially when working with a team or at a company. It is also important that you write clear and concise comments that another developer could easier understand.
It is good practice to add clear and concise comments to your code. This is especially important when working with a team or at a company. It is important that your comments are easily understood by other developers.
Comments are started with `<!--` and ended with `-->`, and can span multiple lines. They can contain code or text, and won't appear on the front-end of the website when a user visits a page. You can view comments through the Inspector Console, or by viewing Page Source.
Comments start with `<!--` and end with `-->`, and can span multiple lines. They can contain code or text, and won't appear on the front-end of the website when a user visits a page. You can view comments through the Inspector Console, or by viewing Page Source.
### Example
```html
<!-- You can comment out a large number of lines like this.
<!-- You can comment out multiple lines like this.
Author: xyz
Date: xx/xx/xxxx
Purpose: abc