HTML 程式碼註釋規範

admin發表於2019-01-07
HTML

註釋對於團隊開發和後期維護有著重要的作用，但是也增加了程式碼的體積。

儘量不寫註釋，儘可能減少文件的體積，如果必須要新增註釋，那麼就要遵循如下規則：

（1）.詳盡註釋，解釋程式碼解決問題、解決思路、是否為新鮮方案等。

（2）.模組註釋，github建議不使用模組結束註釋。

[HTML] 純文字檢視 複製程式碼
<!-- 新聞列表模組 --> 
<div class="news">  
</div>
<!-- /新聞列表模組 --> 
<!-- 有不少規範建議不使用結束模組的註釋，加重檔案負荷 -->

特別說明：註釋文字與兩端（--）之間要有一個空格。

（3）.待辦註釋：

[HTML] 純文字檢視 複製程式碼
<!-- TODO:待辦事項 -->
...

說明還有沒有完成的程式碼，給瀏覽器者一個提示。

（4）.多行註釋：

HTML多行註釋與單行註釋的語法是完全一樣的，只要進行換行即可。

簡單程式碼例項如下：

[HTML] 純文字檢視 複製程式碼執行程式碼
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<meta name="author" content="http://www.softwhy.com/" />
<title>螞蟻部落</title>
</head>
<body>
  <!--螞蟻部落單行註釋-->
  <!--
    螞蟻部落註釋一
    螞蟻部落註釋二
  -->
</body>
</html>

可以看到HTML的註釋採用相同的語法形式，換行既是多行註釋。

相關文章