JavaScript 注释相关

1.单行注释

          快捷键 :  ctrl+ /

2.多行注释

          快捷键 : alt + shift + a

3.JSDoc 注释规则

          快捷键 : 依次输入 / * *

JSDoc注释一般应该放置在方法或函数声明之前，它必须以/ **开始，以便由JSDoc解析器识别。其他任何以/*，/***或者超过3个星号的注释，都将被JSDoc解析器忽略。如下所示：

/**
* 一段简单的 JSDoc 注释。
*/
JSDoc 的注释效果
假如我们有一段这样的代码，没有任何注释，看起来是不是有一定的成本。function Book(title, author) {console.log(title, author)
}

如果使用了 JSDoc 注释该代码后，代码的可阅读性就大大的提高了。

/*** Book类，代表一个书本.* @constructor* @param {string} title - 书本的标题.* @param {string} author - 书本的作者.*/
function Book(title, author) {this.title=title;this.author=author;
}
Book.prototype={/*** 获取书本的标题* @returns {string|*} 返回当前的书本名称*/getTitle:function(){return this.title;},/*** 设置书本的页数* @param pageNum {number} 页数*/setPageNum:function(pageNum){this.pageNum=pageNum;}
};

@constructor 构造函数声明注释
@constructor 明确一个函数是某个类的构造函数。

@param 参数注释
我们通常会使用 @param 来表示函数、类的方法的参数，@param 是JSDoc中最常用的注释标签。参数标签可表示一个参数的参数名、参数类型和参数描述的注释。如下所示：

/*** @param {String} wording 需要说的句子*/
function say(wording) {console.log(wording);
}

@return 返回值注释
@return 表示一个函数的返回值，如果函数没有显示指定返回值可不写。如下所示：

/** @return {Number} 返回值描述*/

@example 示例注释
@example 通常用于表示示例代码,通常示例的代码会另起一行编写，如下所示：

/** @example* multiply(3, 2); */

其他常用注释
@overview 对当前代码文件的描述。
@copyright 代码的版权信息。
@author [] 代码的作者信息。
@version 当前代码的版本。

JavaScript 注释相关相关推荐

java communiframe_[Java教程]javascript iframe相关操作
[Java教程]javascript iframe相关操作 0 2014-08-21 21:02:45 1. 获得iframe的window对象 iframeElement.contentWindow ...
JavaScript（一）—— 初识JavaScript/注释/输入输出语句/变量/数据类型
本篇为 JavaScript 系列笔记第一篇,将陆续更新文章目录一.初识 JavaScript 1. JavaScript 是什么 2. JavaScript 的作用 3. HTML.CSS 和 ...
JavaScript注释（多行注释+单行注释）
JavaScript注释(多行注释+单行注释) 注释就是不被解析的一串字符.JavaScript 注释有以下两种方法: 单行注释://单行注释信息. 多行注释:/*多行注释信息*/. 示例1 把位于/ ...
JavaScript 注释
JavaScript 注释是一种在程序中添加解释性文字的方式,它不会被浏览器或 JavaScript 引擎执行.JavaScript 支持两种类型的注释:单行注释和多行注释. 单行注释以 " ...
JavaScript注释语句
爱码网 JavaScript 的注释和快捷键回答于2022-03-15 添加必要的注释,对一个有责任心.有道德模范的前端必须具备的好习惯, 可以大大提高代码的可维护性.可读性. java代码注释快捷 ...
JavaScript基础第01天笔记——编程语言、计算机基础、JavaScript注释、JavaScript输入输出语句、变量的概念、变量的使用、数据类型、解释型语言和编译型语言、关键字和保留字
1 - 编程语言 1.1 编程编程: 就是让计算机为解决某个问题而使用某种程序设计语言编写程序代码,并最终得到结果的过程. 计算机程序: 就是计算机所执行的一系列的指令集合,而程序全部都是用我们所掌 ...
Javascript元素相关
JavaScript元素相关获取元素根据标签id document.getElementById(); 根据标签名 document.getElementByTagName(); 返回的是获取过来 ...
javascript注释_JavaScript注释
javascript注释 As with HTML & CSS, it is good practice to comment your code: not only for yourself ...
JavaScript基础第01天—编程语言—计算机基础—初始JavaScript—JavaScript注释—JavaScript输入输出语句—变量的使用—数据类型—关键字和保留字
JavaScript基础第01天 1 - 编程语言 1.1 编程编程: 就是让计算机为解决某个问题而使用某种程序设计语言编写程序代码,并最终得到结果的过程. 计算机程序: 就是计算机所执行的一系列的 ...

JavaScript 注释相关

1.单行注释

2.多行注释

3.JSDoc 注释规则

JavaScript 注释相关相关推荐

最新文章

热门文章