什么是文档注释
在JavaScript中，文档注释是一种特殊的注释格式，用于描述代码的功能、使用方法、参数、返回值等信息。文档注释通常使用特定的注释标记和结构来表示，并且可以通过工具解析生成文档。
在JavaScript中，常用的文档注释格式是使用 /** 和 */ 括起来的多行注释。例如：
/**
* 这是一个示例函数，用于加法运算。
* @param {number} a - 第一个操作数
* @param {number} b - 第二个操作数
* @returns {number} - 两个操作数的和
*/
function add(a, b) {
return a + b;
}上面的代码段中，以 /** 开始和以 */ 结束的多行注释就是文档注释。在注释的内容中，使用了一些特殊的标记来表示相关信息，比如 @param 表示参数，@returns 表示返回值。可以在这些标记后面添加具体的描述和类型信息。
为什么要写文档注释
编写JavaScript的文档注释有助于提高代码的可读性、生成易于阅读的API文档、明确接口规范、辅助调试和维护工作，以及促进团队合作和知识共享。这是为了更好地组织和记录代码，并使其更易于理解和使用的最佳实践之一。
提供代码的可读性：文档注释可以帮助其他开发人员更好地理解你的代码。通过提供清晰的注释，可以解释代码的目的、使用方法和重要细节，使代码更易于阅读和维护。自动生成文档：许多开发工具和框架可以根据代码中的文档注释来自动生成文档。例如，JSDoc 是一个常用的JavaScript文档生成工具，它可以解析文档注释并生成API文档。这样其他开发人员就可以轻松地查看代码的接口和用法。提供接口定义和规范：通过文档注释，可以明确说明函数、类、方法和参数的用途、类型和预期行为。这不仅帮助其他开发人员正确使用你的代码，还可以在团队协作中提供一致性和规范。辅助代码调试和维护：当你在调试和维护代码时，文档注释可以提供有关代码功能和实现细节的重要信息。这对于理解复杂的功能和排查问题非常有帮助，尤其是当你需要处理他人编写的代码或长时间未接触的代码时。促进团队合作和知识共享：文档注释可以为开发团队提供一个共享的知识库，使所有人都能理解代码的功能和实现细节。这有助于提高团队成员之间的沟通和协作，并促进代码质量和一致性。
//行注释对于编辑器来说是无效的注释,虽然func从名字上看上去应该是一个方法，但是编辑器(vscode)不知道它是一个函数
// 函数防抖
function debounce(func,duration = 1000) {
}当鼠标放到函数上时，编辑器并不知道这个函数的功能是“函数防抖”
]]
当鼠标放到参数func上时，编辑器并不知道这个参数是函数
不使用文档注释存在的隐患
使用函数成员时的书写问题
在使用函数成员时，能有效的降低书写错误。因此，你在使用函数里面的一些成员的时候
// 函数防抖
function debounce(func,duration = 1000) {
func.aply
}如：当你在debounce函数内部使用func.apply,它没有智能提示，因为它不知道apply是一个函数
那你稍微不注意把单词写错成aply，就增加了出错的几率啊。
在开发过程中，有相当一部分程序问题就是由于单词拼写错误导致的。
有人又说了有AI智能提示不是比文档注释更好用吗？
虽然TypeScript(AI自动补全)就是来解决这个单词书写错误的问题的，毕竟很多项目里面没有上TypeScript (AI自动补全)。这工具也不是你想用就能用的，他涉及到隐私、费用、不支持等等原因。所以TypeScript只能起到锦上添花的作用。
调用函数时功能使用问题
// 函数防抖
function debounce(func,duration = 1000) {
}
debounce在debounce函数使用的时候我们能从这个单词的含义知道，它是一个防抖函数，如果我们把这个函数的名称改成wefwfas，我们不知道他的作用是什么，使用的时候没有任何提示，只知道要传2个参数，至于参数的含义、类型等等都不知道。因此我们最好是写文档注释。
// 函数防抖
function wefwfas(func,duration = 1000) {
}
wefwfas
/**
*
* @param {*} func
* @param {*} duration
*/
function wefwfas(func,duration = 1000) {
}
