2016-04-07 11 views
3

JSDOCを使用してクライアント向けのSDKを文書化しており、「列挙」(すなわち定数)を認識することが困難です。ドキュメンテーションでJSDOCを取得するために使用するタグはどれですか?ここではサンプルです:JSDOC3を使用して列挙定数を文書化する方法

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

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

ここに列挙型が「コードで使用されている方法は次のとおりです。

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

我々はJSDocのでこれを文書化するにはどうすればよいですか?

答えて

1

this article on StackOverflowを確認した後、私は次を使用してこの作業を取得することができました:

/** 
    * @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" 
    */ 
+0

あなたの答えは、元の質問にコードスニペットに対応していないとして、それは、少し不明です –

関連する問題