2017-09-25 133 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

我會立即關閉,離開這件事爲別人誰是有這個煩惱。

回答