前端开发代码注释的作用及运用示范

我们在编写页面的时候，注释是必不成少的一部分，注释一方面可以让本人看清代码的构造，寻起来更利便，另一方面，也有益于同事之间的工作交接，当然代码注释也要标准使用。那么今天就和大家聊聊前端代码的注释吧，有需要的伴侣可以参照 一下，但愿对你有所帮忙。

一、代码注释有什么用

1、和伪代码一样的作用，为接下来要实现的功效写出一个引导性的算法思绪。只是没有伪代码具体。但是也指出了完成此功效的大体算法思绪。
2、给看代码的人一个说明性说明。留意看代码的人包罗你本人。让看你代码的人可以快速的阅读你的代码，不至于每看一行都要一行一行的看下去，才能清楚你写的什么。

二、代码注释标准，遵照以下原则

1、能够帮忙读者更好的理解代码逻辑与构造
2、特殊的或不容易懂得的写法可以说明说明
3、非凡标志注释：如 TODO、FIXME 等有非凡含义的标志
4、文件注释：部分规定会要求在文件头部书写牢固格局的注释，如说明作者、和谈等信息
5、文档类注释：部分规定要求 API类、函数等使用文档类注释（如 jsdoc 风格）
6、遵照统一的风格标准，如必然的空格、空行，以包管注释本身的可读性

三、代码注释如何写

1、HTML代码注释：<!--注释内容 -->;

<!-- html中要注释的内容 -->
在web页面中，最常见的注释就是这种了。我们在规划页面构造的时候，会增加少许的注释利便我们查寻与记忆我们的设法。
那么在页面中除了这样的注释外，还有那些注释呢，这里我列举一些：
If前提不一样版本阅读器注释列表：
<!--[if !IE]>除IE外都可识别<![endif]--> 
<!--[if IE]> 所有的IE可识别 <![endif]-->
<!--[if gt IE 5.0]> IE5.0乃至IE5.0以上版本都可以识别 <![endif]--> 
<!--[if IE 6]> 仅IE6可识别 <![endif]--> 
<!--[if lt IE 6]> IE6乃至IE6以下版本可识别 <![endif]--> 
<!--[if gte IE 6]> IE6乃至IE6以上版本可识别 <![endif]--> 
<!--[if IE 7]> 仅IE7可识别 <![endif]--> 
<!--[if lt IE 7]> IE7乃至IE7以下版本可识别 <![endif]--> 
<!--[if gte IE 7]> IE7乃至IE7以上版本可识别 <![endif]-->

2、CSS代码注释 : /* 注释内容*/

与html中的注释情势不一样，css中的注释采取的是/*css中的注释*/的情势。注释的内容没有单行多行之分。

/*.aa,.bb {
                height: 100px;
                margin: 1px;
                background: #ccc;
            }*/

3、JS代码注释 : //注 释内容; 或者/* 注释内容 */,

与html\css不一样的是，js中的注释存在单行多行的区分，也是品种比力繁多下面就一一介绍。
（1） // 两个歪杠表示单行注释。
（2） <!-- 或者 <!-- --> 使用<!--或者<!-- --> 作为单行注释.
（3）/* */ 多行注释

//          function out(obj){
//              obj.innerHTML = "移出了";
//              obj.style.background = "#ccc";        
//          }

总结：前端开发人员应当深入懂得代码注释的目的和原则，遵照注释规约并结合工具使用，这样才能使注释成为代码良好的辅助，增强可读性和可保护性，从而提高代码质量。

以上就是前端开发代码注释的作用及使用示范的具体内容，更多请关注百分百源码网其它相关文章！