前端开发过程中如何写文档注释

版权声明:本文为博主原创文章,遵循 CC 4.0 by-sa 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/AndyNikolas/article/details/78910802

要学会用jsdoc

1:当你要注释一个函数时,就是不用这个函数了,或者函数版本低了,就需要用到@deprecated

2:一般比如打开 lodash 文档官网,查看一个api,然后打开source,可以看到源代码的和注释,那个注释就是用jsdoc然后生成这个可见的文档页面的。

3:采用VSCODE开发时,写完一个函数后,如果复杂的函数最好写个注释,快捷键是 输入/** 然后按回车键即可自动显示params参数列表

展开阅读全文

没有更多推荐了,返回首页