JSDoc 不仅仅是注释,它还可以用于生成 API 文档、代码自动补全等。在一些开发工具中,如 VS Code、WebStorm 等,JSDoc 注释可以被解析并提供代码提示和文档查看功能。
例如,在 VS Code 中,当你输入一个函数名并按下 `Ctrl + Space`,就会弹出该函数的参数和返回值信息:
![VS Code JSDoc](https://i.imgur.com/8Y3z5B7.png)
此外,许多 JavaScript 库和框架都使用 JSDoc 来标注函数和类的 API,以便其他开发者更好地了解和使用这些库和框架。因此,使用 JSDoc 注释可以提高代码的可读性、可维护性和可重用性,是一种良好的编程习惯。