用于智能感知的 VSCode JSDoc 多行

Question

我希望在我的文档中包含 JSON 示例，而我的文档中又将在我的 VScode 智能感知中包含 JSON 示例。

我已经尝试了书中我能想到的每一个技巧，这是否可以通过换行符和使 JSON 可读的东西来实现？无论我做什么，我都无法让它在 VScode 中工作，它会删除空白并生成一行。

我尝试这样做：

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

这当然最终会像这样进入智能感知......

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

对于小例子来说这是可以的，但我想要更大一点（仍然很小）的简单例子。我确实想要换行还有其他原因，而不仅仅是 JSON，我只是希望我的评论中的文本总体上更清晰。

我还将举出其他人如何记录它的不同例子。我真的希望让我的 JS 代码在使用之前更容易知道该函数将接受、返回和在操作中使用什么。

编辑： 我偶然发现了这个链接：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

这是智能感知的一个错误，已于 4 天前得到纠正，因此应该很快就会发布，因此如果您可以让“悬停”看起来如您所愿，那么当修复失败时，它应该会转换为智能感知。

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