前端：HTML、CSS、JavaScript 代码注释 / 注释与代码规范

作者：System 时间：2024年08月22日分类：所有,css 字数：481

在HTML、CSS和JavaScript中，注释是一种有效的记录代码的方式，它可以帮助开发者理解代码的功能和结构，也可以在调试时临时禁用一部分代码。

HTML注释：




<!-- 这是一个HTML注释 -->
<p>这行代码不会被注释掉</p>

CSS注释：




/* 这是一个CSS注释 */
p {
  color: blue; /* 文本颜色为蓝色 */
}

JavaScript注释：




// 这是一个单行注释
/* 这也是一个单行注释 */
 
/*
 这是一个多行注释
可以跨越多行
*/
 
// 下面是一些示例代码
function sum(a, b) {
  // 这是一个内联注释
  return a + b; // 返回两数之和
}

注释应该用于解释代码的目的和复杂逻辑，有助于代码的阅读和维护。在编写注释时，应遵循简洁和具有教育意义的原则，避免过多冗余的注释，注释内容应精确、准确地反映代码的功能。