html - 你应该如何评论 CSS？

Question

关闭。这个问题是 opinion-based .它目前不接受答案。

---

想要改进这个问题？ 更新问题，以便 editing this post 提供事实和引用来回答它.

关闭 7 年前。

Improve this question

在开发过程中，除了偶尔出现的标题之外，我与之交互的大部分 CSS 都没有注释。结果，我养成了不评论我的 CSS 的习惯。

但是，我经常发现在我正在使用的 CSS 中添加注释会很有用。除了指明作者的标题之外，您还应该评论 CSS 吗？如果有，怎么做？

我问的不是如何评论的过程，而是最佳实践。

Answer 1

我认为一般有两种情况应该使用注释:

1. 如果您正在使用 hack。
2. 为了说明页面结构。

这可能是多余的，但您应该首先问:如何构建 CSS？

通过适当的结构，评论让导航和定位页面中的部分变得轻而易举，例如

/***************
 * UI Elements *
 ***************/
h1, h2, h3, p {
    ...
}
table, form, input, textarea {
    ...
}

/* Custom Radio button hack: use background-image/position on label */
input[type=radio] {
    display:none; 
}
input[type=radio] + label {
    background-image: url(...);
}
input[type=radio]:checked + label {
    background-image: url(...);
}


/**********
 * Header *
 **********/
#site-header {
    ...
}
#logo {
    ...
}

/***********
 * Sidebar *
 ***********/
#site-sidebar {
    ...
}
.item-in-sidebar {
    ...
}

/**********
 * Footer *
 **********/
#site-footer {
    ...
}

任何接触 CSS 的人都应该确信，编辑某些内容(例如，标题部分)不会影响页面上的任何其他内容。如果需要对所有页面和部分的元素样式进行根本性更改，您只需在 CSS 的 UI 元素 部分编辑相关元素。

毋庸置疑，良好的 CSS 结构取决于您的标记是否写得好并且与演示文稿完全分离。如果您的 HTML 受到 div-itis 的困扰，再多的评论都无法帮助您保存 CSS。