VSCode 用于 Intellisense 的 JSDoc 多行

Question

我希望在我的文档中有 JSON 个示例，而这些示例在我的 VScode.

智能感知中也会有 JSON 个示例

我已经尝试了书中我能想到的所有技巧，是否可以使用换行符和使 JSON 可读的东西？无论我做什么，我都无法在 VScode 中使用它，它取出白色 space 并形成一行。

我尝试做：

/**
 * {
 *   "JSONData":"not going to format like this"
 * }
 */
functionToDescribe()

这当然会像这样在智能感知中结束...

{ "JSONData":"not going to format like this" }

这对小例子没问题，但我想要更大一点（仍然很小）的简单例子。我真的想要换行还有其他原因，而不仅仅是 JSON，我只是希望我的评论中的文字总体上更清晰。

我还将举出其他人如何记录它的不同例子。我真的想让我的 JS 代码更容易知道函数接受什么，return 并在使用它之前在操作中使用它。

编辑： 我偶然发现了这个 link：https://github.com/Microsoft/vscode/issues/30062

现在我明白格式在您查看函数或项目的声明时有效，但在您使用它时却无效。

当我将鼠标悬停在函数名称上时，以下标记代码工作得很好，但是当我像往常一样使用它时，它全部在一行上并且毫无价值

    /** This is a description  
     * with each line  
     * on it's own  
     * 
     * @example Test 
     * ```javascript
     * let valueReturned = false;
     * jest.fn(() => {
     *           if (!valueReturned) {
     *             valueReturned = true;
     *             return value;
     *             //no idea why it requires me to have so many spaces...
     *           }
     * });
     * ```
     */ 
     functionTest()  //When hovering over this, it looks great

     functionTest(  //at this point intellisense pops up and is worthless

我认为这是一个错误或仅仅是糟糕的设计，如果它尚不存在，也许我会提出一个功能请求。

如果其他人有任何建议或可能的解决方法，我会保留这个问题。

编辑：

好消息，这似乎是一个错误，在搜索了一段时间后，似乎这个问题在本月就已修复，并将在 9 月发布！

https://github.com/Microsoft/vscode/issues/1920

我现在将关闭它，留给遇到此问题的其他人。

Answer 1

这是 intellisense 的一个错误，截至 4 天前已更正，因此应该会很快发布，所以如果您可以让 "hover" 看起来像您想要的，它应该翻译当修复下降时到 intellisense。

https://github.com/Microsoft/vscode/issues/1920

VSCode 用于 Intellisense 的 JSDoc 多行

VSCode JSDoc Multiline for Intellisense

jsdoc

visual-studio-code