Question

我希望在我的文档中有JSON示例，而这些示例又会在我的智能感知器中为VScode提供JSON示例。

我已经尝试过本书中我能想到的每一个技巧，这可能与换行和使JSON可读的事情有关吗？无论我做什么，我都无法在VScode中使用它，它会占用空白区域并生成一行。

我尝试做：

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

这当然会最终出现在intellisense中......

{ "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天前得到纠正，所以应该很快就会发布，所以如果你能得到＆＃34; hover＆＃34;为了看起来你想要的，它应该在修复程序丢失时转换为intellisense。

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

用于智能感知的VSCode JSDoc Multiline

1 个答案: