【问题标题】:How should you comment CSS? [closed]你应该如何评论 CSS? [关闭]
【发布时间】:2015-09-12 20:43:54
【问题描述】:

在开发过程中,我与之交互的大多数 CSS 都没有 cmets,除了偶尔的标题。结果,我养成了不评论我的 CSS 的习惯。

但是,我经常发现在我正在使用的 CSS 中包含 cmets 会很有用。除了指明作者的标题之外,您还应该评论 CSS 吗?如果有,怎么做?

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

【问题讨论】:

标签: html css web software-design


【解决方案1】:

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

  1. 如果您使用 hack。
  2. 用于说明页面结构。

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

通过适当的结构,cmets 可以轻松导航和定位页面中的部分,例如

/***************
 * 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 的困扰,那么再多的 cmets 也无法帮助您节省 CSS。

【讨论】:

  • 谢谢。它可以帮助我修改 CSS
【解决方案2】:

将 cmets 添加到 CSS 不是标准,但如果您愿意,可以这样做。以下是创建 animate.css 的 Daniel Eden 如何在其 CSS 文件的标题中添加注释的示例:

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

Copyright (c) 2015 Daniel Eden
*/

【讨论】:

    【解决方案3】:

    你可以像这样注释几行 CSS:

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

    或者像这样的单曲:

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

    【讨论】:

      【解决方案4】:

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

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

      【讨论】:

      • HTML cmets 如下所示:<!-- <p>commented out</p> -->
      【解决方案5】:

      您是否选择评论是个人选择的问题。也就是说,这就是你评论 CSS 的方式:

      /* Single Line */
      
      /* Multiple
      Line */
      

      【讨论】:

        【解决方案6】:

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

        【讨论】:

          猜你喜欢
          • 2010-09-12
          • 2014-08-09
          • 1970-01-01
          • 2021-07-12
          • 2014-02-11
          • 1970-01-01
          • 1970-01-01
          • 2014-09-11
          • 1970-01-01
          相关资源
          最近更新 更多