JSDoc 3是用于JavaScript的API文档生成器,类似于Javadoc或phpDocumentor。 您可以将代码注释直接添加到源代码中,并直接添加到源代码中。
我使用JSDoc已有4年以上,发现它非常有用。 在项目中拥有文档很重要。 它可以帮助您节省时间来记住,教新手和支持。 该项目可能具有不同类型的文档。 作为工程师,文档的重要部分是代码文档,而JSDoc也解决了该问题。
简单的例子
从简单的示例中,您可以简单快速地了解函数采用的参数类型。 您不应该在函数内部查看。 通常,函数,方法更复杂,需要花费一些时间才能跳入函数并查看参数的类型。
好的例子
在这里您可以找到模块的详细文档。 只要尝试一下,如果您不明白该模块是什么,我们可能会打电话给☎️
类型注释(类型检查)
我喜欢JSDoc中最强大的功能之一是类型检查。 它在WebStorm中可以完美运行。 它不会替代TypeScript,但是在您习惯于编写JSDoc之后,您将不再担心类型,最重要的是,您无需在任何配置部分上浪费时间。
WebStrom
因此,在这里您可能会看到WebStorm突出显示了哪个参数不适合可分配类型。 它有助于避免类型错误,最重要的是节省时间。
VS代码
VS Code允许您在常规JavaScript文件中利用TypeScript的一些高级类型检查和错误报告功能。 这是捕获常见编程错误的好方法。 这些类型检查还启用了一些激动人心的JavaScript快速修复程序,包括添加缺少的import和添加缺少的property 。
对于VS Code,如果需要,应在每个文件中添加//@ts-check
。
👏 感谢您的阅读。 提出建议,意见,想法 👍
如果您喜欢,拍手,在 medium , twitter , github 上关注我 , 与您的朋友分享 😎
From: https://hackernoon.com/jsdoc-javascript-the-useful-parts-58f52f0cc25e