web前端——你不得不做的代码注释

    哈哈，今天端午节，你吃粽子了没？或者鸡蛋了吧！反正我在吃，边吃边写，真爽！端午节，是纪念我们伟大的诗人屈原，向这位在诗歌方面做出巨大贡献的诗人致敬！

    在我们写css样式的时候，你是否习惯性的把注释写在样式表中？如果不习惯，建议你还是努力养成这样的习惯，因为我们书写css样式表的时候肯定很清楚这些css样式表的作用，或者要实现的效果，那么我们再过6个月或者更久的时候再来看这些代码，你是否还能一眼就能够看出来这些代码的作用或者能够实现的效果？你是否需要把页面源码下载下来才能够帮助你阅读css？如果是这样的话，就悲催了，你的css代码肯定很糟糕，虽然一些很大程度上你可以看得出来这些代码在页面中起到的作用，一些你生僻使用的选择器就不一定能够搞清楚你希望得到的效果了，不过有一点好处就是css容易被人阅读，不容易被人分析出你页面的css书写结构。这就是有一利而有佰害，弊大于利，则不取。下面我们就说说写代码注释的利：

     在css代码中加注释很简单，是再简单不过的事了。css注释开头是/*，结尾是*/。这种注释被成为C网格的注释，因为在C语言中使用的就是这种注释。注释可以是单行也可以是多行：

    /*body styles*/(当然，我只是就例子，像这种注释不用加，这个用眼睛一看就知道写的什么。)
    body{
font-size:67.5%;/*set the font size*/
}
    NO.1添加结构注释
   
    在创建css样式表的时候，第一件事就是在css开头添加一个注释块（一般这个到是不必那么麻烦，纯属个人习惯）
    /*--------------basic style sheet(for wersion4 browsers)--------------------------------
    ----------------date20110604------------------------------------------------------------
    ----------------weili.jia http://www.xxxxxx.com/  chuangyuan.jia@gmail--------------------------
    ----------------company_xxxxxxx--------------------------------------------------------*/
     我们知道浏览器解析时会自动忽略这些东西，所以写一些也无伤大雅，而且这样一来会给自己以后维护，或者交给他人维护的时候提供极大的方便。你可能见过javascript文件里面这样写过，没见过这样写过吗？我是在某国外网站上面下载下来的css源码，顺着他源码中的提示给他发了封邮件，竟然他接到了，给我回了一封，讨论css知识，哈哈，这些不提，那么我们随手的一写既能给后来者或者自己将来修改提供提示，还能让其他人能够找到css的作者，何乐而不为呢？再次声明一下，这只是我个人的习惯，和大家分享一下，并不是一定要注释的。

      如果我们书写的样式特别长，特别是几个页面样式表都在一个样式表中写着，那么我们的结构注释就更加有必要了。因为我们没那么多时间去一行一行阅读，去知道它们想要实现的效果，为什么不加上一段注释呢?

      NO2.自我提示

      有些时候可能需要一些特殊的方式来解决某些不好解决的兼容问题，比如针对IE出现的一些bug，写出一个额外的值来，那么我们就需要注释一些/*IE6/7bug ok*/，这样的话，我们下次维护的时候就能够不误删，也很清楚他想要表达出来了，如果你确实不想让别人知道我写的什么，很简单：/*67IEBO*/这样别人就不知道你写的什么，而自己知道意思是IE6/7 bug ok不过这样的话我们就会有一个固定的注释样式，否则注释也等于没注释，因为再过几个月你就会忘记你注释的什么了！

    NO3.删除样式表中的注释
  
   千万不要那标题和我说话，删除并不是指全部不要，而是尽量的简化。许多html/css和文本编辑器都有搜索替换的功能，因此很容易找到一些不必要的进行删除，还可以替换一些空格，进行减少css文件字节！有些人尝试以PHP格式编写注释，然后将样式表发送给浏览器。这需要在一个.htaccss文件中设置css文档的类型：addtype application/xhttpd-php.css

   但是我们要确保css文件能够被缓存，否则这种方式适得其反不是加快访问速度而是减慢了。这可以使用php来实现，但是比较复杂，所以说除非你非常有把握，否则不要这样做，要不然，会把你打入十八层地狱的！（我没用过，也不建议用。）
    我们知道，注释会让css文件增大，加载速度有点影响！那么我们可以尽量的把注释写的简短，清晰！（建议企业网站使用）像大型门户开发就尽量不使用注释。

        （喜欢学习的和想与我探讨各种web知识的留下你的邮箱或联系方式，或者跟我发邮件747850255@qq.com转载请自觉附上转载地址，来自博客园“明年开奥迪”)

转载于:https://www.cnblogs.com/jiawl/archive/2011/06/06/2073624.html