时间戳

首页 > 解决方案 > 外部文件中的JSDoc，可能吗？如何？

javascript - 外部文件中的JSDoc，可能吗？如何？

问题描述

我认为将 JSDoc 混合到常规（JS）代码中时，它看起来很混乱且难以阅读。是否可以将文档添加到外部文件并引用那里的函数（并使用 JSDoc 让 Visual Studio 的参数类型和返回值的“预览”正常工作）？

我该怎么做才能使这个（或类似的）工作？

我在想这样的事情（3个文件）。

我的文件.html

...
<body>
    ...
    <script src="./JSDock.js"></script>
    <script src="./script.js"></script>
</body>

JSDoc.js

/**
 * @function test
 * @param {string} myText
 * @return int
 * What more should be here?
 */

脚本.js

function test(myText) {
    return 5;
}

标签： javascriptvisual-studioexternaljsdoccode-documentation

解决方案

推荐阅读