Gibt es eine Möglichkeit, Param-Informationen in Javascript zu generieren

Gibt es eine Möglichkeit, Parameterinformationen (Jsdoc-Stil) basierend auf Funktionsimplementierung zu generieren?Gibt es eine Möglichkeit, Param-Informationen in Javascript zu generieren

/** 
 * 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. 
 */

Ich gebe Ihnen ein Beispiel in einem anderen Editor. In Microsoft Visual Studio können Sie /// über eine Funktion eingeben, und es wird XML-Kommentare automatisch für Sie ausstellen.

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

Quelle

2017-10-13 Rod

AFAIK jsdoc Stil ist ähnlich wie Javadoc, was genau Sie tun mögen? Die Kommentare zur Dokumentation hängen normalerweise von der IDE/Editor-Funktion ab. –

Gibt es eine Möglichkeit, dies in Visual Studio oder VS Code zu tun? – Rod

Sie können Intellisense Unterstützung für JSDoc hier lesen: https://msdn.microsoft.com/en-us/library/mt162307.aspx. Die Tag-Namen sind C# -Dokumenten ähnlich, haben aber mit '@' begonnen. –

Es gibt Editor Plugins wie docthis (für Visual Studio-Code), die dies für Sie tun können, sondern weil JavaScript dynamisch typisiert ist, es ist nie so gut sein wie das, was Sie für C# bekommen. Diese Erweiterung funktioniert auch mit TypeScript-Dateien, wo Sie viel mehr Glück haben und genauere Definitionen erhalten (und wenn Sie es nicht als C# -Entwickler benutzt haben, werden Sie wahrscheinlich TypeScript genießen). Es kann ein netter Ansatz sein, in TypeScript zu schreiben, JSDoc-Kommentare mit guten Typinformationen automatisch zu generieren und dann in JavaScript zu kompilieren, während diese Kommentare intakt bleiben.

(BEARBEITEN: Ich nehme an, Sie wollten, dass der Editor automatisch die Parametertypen für Sie ableitet und ausschreibt. Wenn Sie nur mit den Namen, aber sonst nichts erstellen, unterstützt VS Code diese sofort nur durch /** und Drücken der Tabulatortaste und andere Editoren eingeben würde sicherlich die gleiche Funktionalität hinter einem Plugin.)

Quelle

2017-10-13 04:22:46

In den meisten des Editor backslash(/) von zwei Sternen gefolgt (**) & Eingabe/Return wird die function Informationen erzeugen.

aber vor, dass die Funktion Bedarf mit Parametern

JSDOC javascript.It mit beide intellij & Visual Studio arbeitet bei der Dokumentation helfen kann definiert werden. Für Visual Studio kann das Plugin von here

für sublimen Text DocBlockr ist ein hilfreiches Paket zur Verfügung

Quelle

2017-10-13 04:25:28 brk

Gibt es eine Möglichkeit, Param-Informationen in Javascript zu generieren

Antwort

Verwandte Themen