前端开发过程中如何写文档注释
要学会用jsdoc1：当你要注释一个函数时，就是不用这个函数了，或者函数版本低了，就需要用到@deprecated2：一般比如打开 lodash 文档官网，查看一个api，然后打开source，可以看到源代码的和注释，那个注释就是用jsdoc然后生成这个可见的文档页面的。3：采用VSCODE开发时，写完一个函数后，如果复杂的函数最好写个注释，快捷键是 输入/** 然后按回车键即可自动显示param
·
要学会用jsdoc
1：当你要注释一个函数时，就是不用这个函数了，或者函数版本低了，就需要用到@deprecated
2：一般比如打开 lodash 文档官网，查看一个api，然后打开source，可以看到源代码的和注释，那个注释就是用jsdoc然后生成这个可见的文档页面的。
3：采用VSCODE开发时，写完一个函数后，如果复杂的函数最好写个注释，快捷键是 输入/** 然后按回车键即可自动显示params参数列表
开放原子开发者工作坊旨在鼓励更多人参与开源活动，与志同道合的开发者们相互交流开发经验、分享开发心得、获取前沿技术趋势。工作坊有多种形式的开发者活动，如meetup、训练营等，主打技术交流，干货满满，真诚地邀请各位开发者共同参与！
更多推荐
0
0- 0
已为社区贡献3条内容
所有评论(0)