我什么时候应该使用 JSDocs？

Question

我知道对于带有 export 的函数，JSDocs 非常有用，但在其他情况下我应该使用它吗？

例如，为没有 export 的函数添加 JSDocs 是有意义的吗？

Answer 1

在切换到 Typescript 之前，我倾向于使用 JSDocs 作为权宜之计，以便为我的 IDE 提供更好的提前输入信息。否则，当您需要有关您正在处理的任何内容的一些额外信息时，只需使用 JSDocs，无论是在使用他人代码的情况下的归因，还是可以通过将鼠标悬停在编辑器上来显示的更好的描述。