你应该如何评论CSS?

时间:2015-06-26 02:38:01

标签: html css web software-design

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

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

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

6 个答案:

答案 0 :(得分:3)

我认为通常有两种情况应该使用评论:

  1. 如果您正在使用黑客攻击。
  2. 说明页面结构。
  3. 这可能不是问题,但你应该先问:如何构建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 *
     ***********/
    #sidebar {
        ...
    }
    .article-in-sidebar {
        ...
    }
    
    /**********
     * Footer *
     **********/
    #site-footer {
        ...
    }
    

    任何触摸CSS的人都应该相信,在标题部分编辑内容不会影响页面上的任何其他内容。如果所有页面和部分都需要对元素样式进行根本性更改,那么您需要做的就是编辑UI元素中的相关元素。

    当然,这仍然取决于您的标记是否写得好并且与演示文稿完全分开。如果您的HTML受到div-itis的影响,那么没有任何评论可以帮助您保存CSS。

答案 1 :(得分:1)

它不是向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
*/




答案 2 :(得分:0)

您可以像这样评论几行CSS:

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

或者像这样的单身:

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

答案 3 :(得分:0)

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

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

答案 4 :(得分:0)

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

/* Single Line */

/* Multiple
Line */

答案 5 :(得分:0)

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