Verwendung von JSDOC3 zum Dokumentieren von Enum-Konstanten

Question

Wir verwenden JSDOC, um unser Client-seitiges SDK zu dokumentieren, und wir haben Schwierigkeiten, unsere Enums (d. H. Konstanten) zu erkennen. Welche Tags sollten wir verwenden, um JSDOC in die Dokumentation aufzunehmen? Hier ist ein Beispiel:

/** 
* @module Enum 
*/ 
export namespace { 

    /** 
    * @enum WidgetType {string} 
    */ 
    Enum.WidgetType = { 
     /** Dashboard */ 
     Dashboard: 'dashboard', 
     /** Form */ 
     Form: 'entityeditform', 
     /** Report */ 
     Report: 'report' 
    }; 
} 

Hier ist, wie die 'Aufzählungen' in Code verwendet:

app.widget({ id: 'account_entityform', type: Enum.WidgetType.Form }).add(); 

Wie können wir das Dokument mit JSDOC?

Answer 1

Nach this article on StackOverflow Überprüfung konnte ich diese Funktion erhalten mit der folgenden:

/** 
    * @typedef FieldType 
    * @property {string} Text "text" 
    * @property {string} Date "date" 
    * @property {string} DateTime "datetime" 
    * @property {string} Number "number" 
    * @property {string} Currency "currency" 
    * @property {string} CheckBox "checkbox" 
    * @property {string} ComboBox "combobox" 
    * @property {string} Dropdownlist "dropdownlist" 
    * @property {string} Label "label" 
    * @property {string} TextArea "textarea" 
    * @property {string} JsonEditor "jsoneditor" 
    * @property {string} NoteEditor "noteeditor" 
    * @property {string} ScriptEditor "scripteditor" 
    * @property {string} SqlEditor "sqleditor" 
    */