标签：多行 标签 param 注释 jsdoc 使用 JSDoc 方法

1、需求：写项目的时候，有一些很久之前的代码经常忘了有啥功能，用//写注释吧，多个地方用也要多个地方去写，十分麻烦，今天看别人项目时发现别人用的是@param来写的注释，只要定义变量或方法时注释，在其他地方使用鼠标移上去就能看到注释，十分方便

 2、使用：方法很简单在你定义的变量前使用多行注释（复杂的注释格式可参照jsdoc：https://jsdoc.app/）

/**
  * @description: 描述
  * @param{类型}参数名1 Must
  * @param{类型}参数名2 Optional
  * @returns{类型}
*/

3、跟注释相关的一个库，感觉在比较大且复杂的项目中可以用到：jsdoc

JSDoc是一个根据javascript文件中注释信息，生成JavaScript应用程序或库、模块的API文档 的工具。你可以使用他记录如：命名空间，类，方法，方法参数等。类似JavaDoc和PHPDoc。现在很多编辑器或IDE中还可以通过JSDoc直接或使用插件生成智能提示。从而使开发者很容易了解整个类和其中的属性和方法，并且快速知道如何使用，从而提高开发效率，降低维护成本。

标签：多行,标签,param,注释,jsdoc,使用,JSDoc,方法
来源： https://www.cnblogs.com/lovewhatIlove/p/15785262.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。