2017-10-13 95 views
0

有沒有一種方法可以根據函數實現生成參數信息(jsdoc樣式)?有沒有一種方法可以在JavaScript中生成參數信息

/** 
 * Assign the project to a list of employees. 
 * @param {Object[]} employees - The employees who are responsible for the project. 
 * @param {string} employees[].name - The name of an employee. 
 * @param {string} employees[].department - The employee's department. 
 */ 

我會給你一個例如在另一個編輯器。在Microsoft Visual Studio中,你可以在函數上面輸入///,它會自動爲你寫出xml註釋。

/// <summary> 
    /// 
    /// </summary> 
    /// <param name="input1"></param> 
    /// <param name="input2"></param> 
    /// <returns></returns> 
    public static decimal Add(string input1, string input2) 
+0

AFAIK jsdoc風格類似於Javadoc中,你想做什麼?文檔註釋通常取決於IDE /編輯器功能。 –

+0

有沒有辦法在Visual Studio或VS Code中做到這一點? – Rod

+0

您可以在這裏閱讀Intellisense對JSDoc的支持:https://msdn.microsoft.com/en-us/library/mt162307.aspx。標籤名稱與C#文檔類似,但以「@」開頭。 –

回答

0

有編輯器插件,像docthis(對於Visual Studio代碼),可以爲你做這個,但是,因爲JavaScript是動態類型的,它永遠不會是因爲什麼,你會得到C#一樣好。同樣的擴展也適用於TypeScript文件,在那裏你會有更多的運氣和更精確的定義(如果你還沒有使用它,作爲C#開發者,你可能會喜歡TypeScript)。它可以是一種很好的方法來編寫TypeScript,自動生成帶有良好類型信息的JSDoc註釋,然後編譯爲JavaScript,同時保持這些註釋不變。編輯:我想你希望編輯器自動推斷並寫出你的參數類型,如果你只是用名稱創建樣板文件,但沒有其他的,VS代碼支持這個開箱即用通過只輸入/**和按Tab鍵,和其他編輯肯定有一個插件後面相同的功能。)

0

在大多數其次是二星級(**)&輸入/回報將產生function信息編輯backslash(/)的。

但該功能之前需要與參數

JSDOC可以記錄javascript.It幫助定義既intellij &視覺工作室的作品。對於Visual Studio,該插件可以從here

對於崇高的文本DocBlockr是一個有用的包

相關問題