2017-09-25 78 views
1

我正在寻找在我的文档中有JSON示例,而我的文档中将会有我的智能感知VScode中的JSON示例。VSCode JSDoc Multiline for Intellisense

我已经试过本书中的每一个技巧,我可以想到,这是可能做的换行符和使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

我会立即关闭,离开这件事为别人谁是有这个烦恼。

回答