2017-10-13 16 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

私の知る限りのJSDocのスタイルは、Javadocのに似ているのですか?ドキュメンテーションコメントは、通常、IDE /エディタの機能に依存します。 –

+0

Visual StudioまたはVS Codeでこれを行う方法はありますか? – Rod

+0

IntellisenseのJSDocサポートは、https://msdn.microsoft.com/en-us/library/mt162307.aspxで読むことができます。タグ名はC#docsに似ていますが、 '@'で始まります。 –

答えて

0

はあなたのためにこれを行うことができます(Visual Studioのコード用)docthisなどのエディタのプラグインがありますが、JavaScriptは動的型付けされているので、決してあなたがC#のために買ってあげる何として良いことを行っていないです。同じ拡張機能はTypeScriptファイルでも動作します。ここではもっと運があり、より正確な定義が得られます(C#開発者として使用していない場合は、おそらくTypeScriptを楽しむでしょう)。 TypeScriptで記述し、適切な型情報を持つJSDocコメントを自動生成し、そのコメントを損なわずにJavaScriptにコンパイルするのは良い方法です。

(EDIT:エディタで自動的にパラメータタイプを推論して書き出すことを前提としています。名前だけで定型文を作成するだけで大​​丈夫ならば、VSコードはこれをそのまま使用できます2つの星(**)&入力/復帰はfunction情報を生成します続いエディタbackslash(/)のほとんどはちょうど/**を入力してTabキーを押すと、他のエディタによって確実にプラグインの背後に同じ機能を持っているでしょう。)

0

しかし、パラメータ

JSDOCで定義される関数の必要性がjavascript.Itの文書化に役立つことを前にすると、両方のintellij &のVisual Studioで動作します。 Visual Studio用プラグインは、崇高なテキストDocBlockrについてhere

から入手することができ、あなたがやりたいまさに、役に立つパッケージ

関連する問題