你应该如何评论CSS？

Question

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

但是,我经常发现在我正在使用的CSS中添加注释会很有用.除了指示作者的标题之外,你应该评论CSS吗？如果是这样,怎么样？

我不是在询问如何评论的过程,而是最佳实践.

Answer 1

我认为通常在两种情况下都应使用注释：

1. 如果您正在使用骇客。
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陷入了困境，那么没有任何注释可以帮助您保存CSS。