189 8069 5689

前端开发代码如何注释

今天就跟大家聊聊有关前端开发代码如何注释，可能很多人都不太了解，为了让大家更加了解，小编给大家总结了以下内容，希望大家根据这篇文章可以有所收获。

创新互联坚持“要么做到，要么别承诺”的工作理念，服务领域包括：网站建设、网站设计、企业官网、英文网站、手机端网站、网站推广等服务，满足客户于互联网时代的庆城网站设计、移动媒体设计的需求，帮助企业找到有效的互联网解决方案。努力成为您成熟可靠的网络建设合作伙伴！

一、代码注释有什么用

1、和伪代码一样的作用，为接下来要实现的功能写出一个指导性的算法思路。只是没有伪代码详细。但是也指出了完成此功能的大体算法思路。
2、给看代码的人一个解释性说明。注意看代码的人包括你自己。让看你代码的人可以快速的浏览你的代码，不至于每看一行都要一行一行的看下去，才能明白你写的什么。

二、代码注释规范，遵循以下原则

1、能够帮助读者更好的了解代码逻辑与结构
2、特别的或不容易理解的写法可以解释说明
3、特殊标记注释：如 TODO、FIXME 等有特殊含义的标记
4、文件注释：部分规定会要求在文件头部书写固定格式的注释，如注明作者、协议等信息
5、文档类注释：部分规定要求 API类、函数等使用文档类注释（如 jsdoc 风格）
6、遵循统一的风格规范，如一定的空格、空行，以保证注释自身的可读性

三、代码注释怎么写

1、HTML代码注释：;


在web页面中，最常见的注释就是这种了。我们在布局页面结构的时候，会添加少许的注释方便我们查找与记忆我们的想法。
那么在页面中除了这样的注释外，还有那些注释呢，这里我列举一些：
If条件不同版本浏览器注释列表：

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";        
//          }

看完上述内容，你们对前端开发代码如何注释有进一步的了解吗？如果还想了解更多知识或者相关内容，请关注创新互联行业资讯频道，感谢大家的支持。


网站题目：前端开发代码如何注释
文章路径：http://cdxtjz.cn/article/pjdeci.html

其他资讯