JavaScript注释规范

你好,我是云桃桃。

一个希望帮助更多朋友快速入门 WEB 前端的程序媛。

云桃桃 ,大专生,一枚程序媛,感谢关注。回复 “前端基础题”,可免费获得前端基础 100 题汇总,回复 “前端基础路线”,可获取完整web基础路线导图。

308篇原创内容-更多前端系列内容可以go公众.h:云桃桃

后台回复“前端基础路线”可获取前端基础学习路线

后台回复“前端基础题”可得到前端基础100题汇总,持续更新中

后台回复“前端电子书”可获取20+本精选电子书

前言

在 JavaScript 中,注释就像是代码中的笔记,它可以帮助我们解释代码的功能、记录重要信息或者暂时禁用一段代码。

好,那我们一起来看看吧。

2 种注释的写法

以下是 JavaScript 中常见的注释方式:

  1. 单行注释:使用//开头,注释内容从//开始到本行结束。

  2. 多行注释:使用/*开头,*/结尾,注释内容可以跨越多行。

代码如下:

// 这是一个单行注释
let myVariable = 5/* 这是一个多行注释,用于解释下面的代码逻辑let myFunction = function() {console.log("Hello, World!");}
*/

要注意的是,多行注释不能嵌套多行注释,以下是一个错误的注释嵌套示例。

  /*这是一个/*注释这是一个嵌套的*/注释*/

在代码里也会有报错的提示,如图。

图片

注释的常见作用有以下 4 点:

  1. 解释代码:通过添加注释,可以让其他人更容易理解你的代码逻辑和意图。

// 这是一个计算圆的面积的函数
function calculateCircleArea(radius) {return Math.PI * radius * radius
}
  1. 记录重要信息:可以在注释中记录代码的版本、作者、日期等重要信息。

// 作者:桃
// 创建日期:2024-05-06
function myFunction() {// 这里实现了具体的功能
}
  1. 暂时禁用代码:在调试或测试代码时,可以使用注释暂时禁用一段代码,以便观察代码的执行效果。

// 注释掉这段代码,暂时禁用它
// console.log(name)
console.log(name + '测试测试666666')
  1. 提高代码的可读性:合理的注释可以使代码更加清晰,易于阅读和维护。

function myComplexFunction() {// 初始化变量let x = 0let y = 0// 执行复杂的计算逻辑// 返回计算结果return x + y
}

注释的 4 个注意点

  1. 注释应该与代码保持一致,当代码发生变化时,注释也应该相应地更新。

  2. 避免在注释中写下与代码无关的内容,以免干扰其他人对代码的理解。

  3. 对于复杂的代码块或函数,可以在注释中提供更多的解释和说明,帮助其他人更好地理解代码的结构和逻辑。

  4. 不要过度注释,应该只在必要的地方添加注释,以免影响代码的可读性。

OK,本文完。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.hqwc.cn/news/670712.html

如若内容造成侵权/违法违规/事实不符,请联系编程知识网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

JSON原生AJAX

文章目录 JSONFastjsonfastjson引入fastjson 常用APIfastjson作用常用API使用实例 ajax和json综合(重要)请求参数和响应数据都是普通字符串响应数据改为json格式请求和响应都是js数据封装到Result类和抽取到BaseController 原生AjaxAJAX的执行流程XMLHttpRequest对象使用原生的…

寻找最佳App分发平台:小猪APP分发脱颖而出

在当今移动应用市场日益饱和的环境下,选择一个合适的App分发平台对于开发者来说至关重要。这不仅关系到应用能否快速触达目标用户,还直接影响到品牌的塑造与市场份额的争夺。本文将深入探讨几大关键因素,帮助开发者判断哪个App分发平台最适合…

07 - 步骤 javaScript代码

简介 JavaScript 代码是通过 JavaScript 脚本步骤来执行 JavaScript 脚本的一种方式。这允许用户在 Kettle 的数据流程中使用 JavaScript 编写自定义的脚本逻辑,用于数据处理、转换、计算等操作。 使用 场景 我需要在数据流加一个字段 createTime 当前时间&…

Typescript语法二

继承 继承是⾯向对象编程中的重要机制,允许⼀个类(⼦类或派⽣类)继承另⼀个类(⽗类或基类)的属性和⽅法。⼦类可以直接使⽤⽗类的特性,并根据需要添加新的特性或覆盖现有的特性。这种机制赋予⾯向对象程序良…

【2024最新华为OD-C卷试题汇总】停车场车位统计(100分) - 三语言AC题解(Python/Java/Cpp)

🍭 大家好这里是清隆学长 ,一枚热爱算法的程序员 ✨ 本系列打算持续跟新华为OD-C卷的三语言AC题解 💻 ACM银牌🥈| 多次AK大厂笔试 | 编程一对一辅导 👏 感谢大家的订阅➕ 和 喜欢💗 文章目录 前…

力扣刷题:四数相加Ⅱ

题目详情: 解法一:暴力枚举 对于这道题,我们的第一思路就是暴力枚举,我们可以写一个四层的for循环进行暴力匹配,只要相加的结果等于0就进行统计。但是我们会发现,我们的事件复杂度为O(N^4)事件复杂度非常大…

第3章 WebServer重构

3.1 重构原生Web服务框架 3.1.1 分析原生Web服务框架 在服务端代码的 ClientHandler 中,请求解析、处理请求、返回响应的代码混杂在一起,这样的设计会导致代码难以维护和理解。为了提高代码的可读性、可维护性和可扩展性,我们需要对这些代码…

基于C++基础知识的循环语句

一、while循环 while循环语句形式如下: while(表达式){语句 } 循环每次都是执行完语句后回到表达式处重新开始判断,重新计算表达式的值,一旦表达式的值为假就退出循环。用花括号括起来的多条简单语句,花括号及其包含的语句被称…

VueComponent构造函数

//创建school组件——注册给谁 在谁的结构上写const school Vue.extend({name: school,//开发者工具的显示template: <div><h2>学校名称&#xff1a;{{schoolName}}</h2><h2>学校地址&#xff1a;{{adress}}</h2> </div>,//结构data() {…

攻防世界-xff-referer

题目信息 分析过程 显示ip必须为123.123.123.123&#xff0c;则进行伪造 解题过程 打开repeator 提示必须来自https://www.google.com&#xff0c;则再次构造Referer 相关知识 x-forwarded-for 和 referer的区别: x-forwarded-for 用来证明ip的像是“127.0.0.1”这种&a…

Linux 第十九章

&#x1f436;博主主页&#xff1a;ᰔᩚ. 一怀明月ꦿ ❤️‍&#x1f525;专栏系列&#xff1a;线性代数&#xff0c;C初学者入门训练&#xff0c;题解C&#xff0c;C的使用文章&#xff0c;「初学」C&#xff0c;linux &#x1f525;座右铭&#xff1a;“不要等到什么都没有了…

QtWindows任务栏

目录 引言任务栏进度右键菜单缩略图工具栏完整代码 引言 针对Windows系统的任务栏&#xff0c;Qt基于系统的原生接口封装有一些非常见类&#xff0c;如QWinTaskbarButton、QWinTaskbarButton、QWinThumbnailToolBar等&#xff0c;用于利用工具栏提供更多的信息&#xff0c;诸如…