HTML coding conventions

Many web developers know little about HTML coding conventions.

Between 2000 and 2010, many web developers converted from HTML to XHTML.

Using XHTML developers have gradually developed better HTML writing standards.

For HTML5, we should form better code standards. The following provides several standard suggestions.

Use the correct document type

The document type declaration is located on the first line of the HTML document:

If you want to use lowercase like other tags, you can use the following code:

Use lowercase element names

HTML5 Element names can use uppercase and lowercase letters.

Recommended to use lowercase letters:

Mixing upper and lower case style is very bad.

Developers typically use lowercase (similar to XHTML).

The lowercase style looks more refreshing.

Lowercase letters are easy to write.

Not recommended:

 
这是一个段落。
 

Very bad:

 
这是一个段落。
 

Recommended:

 
这是一个段落。
 

Closing all HTML elements

In HTML5, you don't have to close all elements (such as

elements), but we recommend adding a closing tag to each element.

Not recommended:

 
这是一个段落。 
这是一个段落。 

Recommended:

 
这是一个段落。
 
这是一个段落。
 

Close empty HTML elements

In HTML5, empty HTML elements do not have to be closed:

We can write like this:

We can also write like this:

In XHTML The slash (/) is required in XML.

It's good to use this style if you expect XML software to use your page.

Use lowercase attribute names

HTML5 attribute names allow the use of uppercase and lowercase letters.

We recommend using lowercase letters for attribute names:

It is a very bad habit to use uppercase letters at the same time.

Developers typically use lowercase (similar to XHTML).

The lowercase style looks more refreshing.

Lowercase letters are easy to write.

Not recommended:

Recommended:

Attribute value

HTML5 attribute values can be used without quotes.

We recommend using quotation marks for attribute values:

If the attribute value contains spaces, you need to use quotation marks.

Mixing styles is not recommended, it is recommended to unify the style.

Use quotation marks for attribute values to make them easier to read.

The following example attribute values contain spaces and do not use quotation marks, so they cannot work:

The following uses double quotation marks, which is correct of:

Image attributes

Images usually use the alt attribute. When the picture cannot be displayed, it can replace the picture display.

Define the size of the image and reserve designated space when loading to reduce flickering.

Spaces and equal sign

You can use spaces before and after the equal sign.

But we recommend using less spaces:

Avoid a line of code that is too long

When using the HTML editor, it is inconvenient to scroll the code left and right. .

Try to keep each line of code to less than 80 characters.

Blank lines and indentation

Don’t add blank lines for no reason.

Add blank lines to each logical function block to make it easier to read.

Use two spaces for indentation, and TAB is not recommended.

Do not use unnecessary blank lines or indentation between shorter codes.

Unnecessary blank lines and indentation:

 
相思
 
HTML
 
 红豆生南国，春来发几枝。 愿君多采撷，此物最相思。 
 

Recommendation:

 
相思
 
 
红豆生南国，春来发几枝。 愿君多采撷，此物最相思。
 

Table example:

Name	Description
A	Description of A
B	Description of B

List example:

 
London
 
Paris
 
Tokyo
 

Omit and ?

In standard HTML5, the and tags can be omitted.

The following HTML5 document is correct:

Example:

   
 
标题
 
段落。

Omitting the and tags is not recommended. The

element is the root element of the document and is used to describe the language of the page:

The declared language is for the convenience of screen readers and search engines.

Omitting or will crash in DOM and XML software.

Omitting will cause an error in older browsers (IE9).

Omit ?

In standard HTML5, the tag can be omitted.

By default, the browser will add the content before to a default element.

Example

    
标题
 
段落。
  

Omitting the head tag is not recommended now.

Metadata

The ;

The title and language can let search engines quickly understand the topic of your page:

HTML comments

Comments can be written in ; in:

Longer comments can be written in separate lines between :

The first character of long comments is indented by two spaces to make it easier to read.

Style sheet

The style sheet uses a concise syntax format (the type attribute is not required):

Short rules can be written in one line:

p.into {font-family: Verdana; font-size: 16em;}

Long rules can be written in multiple lines:

body {
background-color: lightgrey;
font-family: "Arial Black", Helvetica, sans-serif;
font -size: 16em;
color: black;
}

Put the opening curly brace on the same line as the selector.

Add a space between the left curly brace and the selector.

Use two spaces for indentation.

Add a space between the colon and the attribute value.

Use a space after commas and symbols.

Use a symbol at the end of each attribute and value.

Use quotes only if the attribute value contains spaces.

The right curly brace is placed on a new line.

Maximum 80 characters per line.

A common rule is to add spaces after commas and semicolons.

Loading JavaScript in HTML

Use concise syntax to load external script files (the type attribute is not required):

段落 1。

段落 2。

Try to use the same naming rules for JavaScript in HTML.

Access JavaScript code specifications.

Use lowercase file names

Most web servers (Apache, Unix) are case-sensitive: london.jpg cannot be accessed through London.jpg.

Other web servers (Microsoft, IIS) are not case sensitive: london.jpg can be accessed as London.jpg or london.jpg.

You must maintain a consistent style. We recommend using lowercase file names uniformly.

File extension

HTML file suffix can be .html (or r .htm).

CSS file suffix is .css.

JavaScript file suffix is .js. The difference between

.htm and .html There is essentially no difference between the extension files of .htm and .html. Both browsers and web servers treat them as HTML files.

The difference is:

.htm was used in early DOS systems, and the system now only has three characters.

There are no special restrictions on the suffix in Unix systems, generally .html is used.

Technical difference

If a URL does not specify a file name (such as //m.sbmmt.com/css/), the server will return the default file name. Typically the default file names are index.html, index.htm, default.html, and default.htm.

If the server is configured with only "index.html" as the default file, you must name the file "index.html", not "index.htm".

However, usually the server can set multiple default files, can you set the default file as needed.

Anyway, the complete suffix of HTML is ".html".