你应该如何评论CSS？

Question

在开发过程中，与我互动的大多数 CSS 没有评论，除了偶尔 header。结果，我养成了不评论我的 CSS.

的习惯

但是，我经常发现在我正在使用的 CSS 中发表评论会很有用。除了 header 表明作者之外，你还应该评论 CSS 吗？如果可以，怎么做？

我问的不是流程怎么评论，而是最佳实践。

Answer 1

你可以评论几行CSS，像这样：

/*
******Commented Out******
*/

或像这样的单曲：

#someid {
    width: 90%;
    /* background: black; */
}

Answer 2

只需使用 /* ---- */ 注释掉一些块。

/* .myBtns:hover {
        text-decoration: none;
        color: white;
        cursor: pointer;
} */

Answer 3

是否选择评论是个人选择的问题。也就是说，这就是您评论 CSS:

的方式

/* Single Line */

/* Multiple
Line */

Answer 4

向 CSS 添加评论不是标准，但如果您愿意，可以这样做。以下是创建 animate.css 的 Daniel Eden 如何在其 CSS 文件的 header 中添加评论的示例：

/*!
Animate.css - http://daneden.me/animate
Licensed under the MIT license - http://opensource.org/licenses/MIT

Copyright (c) 2015 Daniel Eden
*/

Answer 5

我觉得一般有两种情况应该使用注释：

如果您使用黑客。
为了说明页面结构。

这可能不是问题，但你应该先问：如何构造CSS？

通过适当的结构，评论可以breeze导航和定位页面中的部分，例如

/***************
 * 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 的人都应该确信在 header 部分中编辑某些内容不会影响页面上的任何其他内容。如果需要对所有页面和部分的元素样式进行根本性更改，您需要做的就是编辑 [=33= 的 UI Elements 部分中的相关元素].

不用说，良好的 CSS 结构取决于您的标记是 well-written 并且与演示文稿完全分开。如果您的 HTML 患有 div-itis，再多的评论也无法挽救您的 CSS。

Answer 6

您可以使用 /* Comment of CSS */.

你应该如何评论CSS？

How should you comment CSS?

html

css

software-design

web