从jsduck迁移到jsdoc

问题描述

我想迁移许多以前用 jsduck 记录的JavaScript代码。现在我想将它们全部迁移到 jsdoc 。 如果您能帮助我,那太好了。因为我找不到任何来源。 因此,实际上,我还希望编写一个脚本来自动执行此操作。

解决方法

我想首先您需要熟悉JSDoc documentation,并了解JSDoc v / s JSDuck语法的所有差异。

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

然后,您将需要重写doc-comments以使用JSDoc语法表达此信息。我可以建议使用recastjscodeshift之类的工具来执行JS代码部分(注释)的修改,而无需更改代码的任何其他部分。

可能有更简单的方法,例如某些@tags的正则表达式搜索替换。虽然这实际上取决于文档注释的编写方式。