Javascript 有没有可能让jsdoc在与源代码分开的文件中查找该代码的文档？

我希望内联评论尽可能简短，因为我的经验是，超过3或4行的评论往往会被掩盖，从而产生许多不必要的“阅读手册行”

legacy要求我遵守与jsdoc兼容的格式来记录代码。它要求很多不言而喻的事情都要明确声明，如果它们要被正确地记录下来的话。实际上，每个标签都属于这一类。即使是那些没有的，对于一个正在工作的开发人员来说也是无用的

我的设想是在代码内部有一个开发人员实际阅读的快速摘要，但要进行额外的标记，请参考一个单独的文件（或者甚至是同一文件中的注释转储，与开发人员工作的位置不同），如下所示：

/**
 *  Used when making an example of the argument.
 *  @include someotherplace
 */
function example(argument) { stuff;}

...lots more code...

/**
 *  someotherplace
 *  @param argument The victim
 *  @since forever
 *  @other stuff
 */

---

一个不同的工具或插件是可以接受的，我只是被语法所困扰。另一种选择是一个具有一些非常好的隐式文档创建的工具

那么{@link}标记和教程{@tutorial}标记呢？从文件：

{@tutorial}教程

教程机制不仅允许您包含与短代码相关的技术API文档，还允许您包含更长、更具说明性的整页教程

{@link}标记允许您从任何标记描述的文本中创建指向其他文档化符号的HTML链接

用法：

@anyTag This is some text {@link otherSymbol}.

---

有了jsdoc3，我不认为有什么方法可以得到完美的结果 解决方案，无需编写新插件。（我不知道有没有 已经可以使用的插件。）

但是，有可能滥用jsdoc标记来获取 它不是完美的，但很实用

/**
 * @module foo
 */


/**
 * Used when making an example of the argument.
 * @see {module:foo.example_type}
 */
function example(argument) {
    //...
}

/**
 * someotherplace
 * @typedef {function} module:foo.example_type
 * @param argument The victim
 * @since forever
 */

关键是创建一个具有唯一名称的类型定义，然后 使用

@请参见

链接到该定义<代码>@模块和

模块：

只是为了显示它可以通过模块来完成。他们可能只是

---

在不需要模块的情况下剥离。

谢谢，但这会为简短文档创建一页，并链接到包含其他文档的第二页。我希望把它们都放在一个页面上。你使用的是jsdoc的哪个版本？jsdoc 2和jsdoc 3之间有很大的区别。我将使用解决问题的版本，但由于它仍然处于活动状态，我更喜欢使用3。Typescript允许您将参数类型存储在单独的文件中。也许它也会让你把它们记录在那里。