javascript - 从 jsduck 迁移到 jsdoc

Question

我想迁移之前用jsduck记录的大量 JavaScript 代码。现在我想将它们全部迁移到jsdoc。如果你能帮助我，那就太好了。因为我找不到任何来源。所以，实际上我也更愿意编写一个脚本来自动执行此操作。

Answer 1

我想首先您需要熟悉JSDoc 文档并了解 JSDoc 与 JSDuck 语法的所有差异。

--export您可以使用该选项将 JSDuck 知道的所有内容导出到 JSON 文件。

然后，您需要重写 doc-comments 以使用 JSDoc 语法表达此信息。我可以建议使用 recast 或 jscodeshift 等工具来修改部分JS 代码（注释），而无需更改代码的任何其他部分。

可能有更简单的方法，例如 regex search-replace of some @tags。尽管这实际上完全取决于您的文档注释的编写方式。