2013-02-20 5 views
5

Ich versuche, ein CustomTag zu Jsdoc hinzuzufügen.Wie fügt man ein Tag in jsdoc ein und verwendet es?

method.js

exports.defineTags = function(dictionary) { 
    dictionary.defineTag("methodHttp", { 
     mustHaveValue: true, 
     canHaveType: false, 
     canHaveName: true, 
     onTagged: function(doclet, tag) { 
      doclet.methodHttp = tag.value; 
     } 
    }); 
}; 

Dann habe ich zu meinem conf.json hinzugefügt: Ich habe eine Datei in dem Plugin-Verzeichnis wie folgt erstellt

{ 
    "tags": { 
     "allowUnknownTags": true 
    }, 
    "source": { 
     "includePattern": ".+\\.js(doc)?$", 
     "excludePattern": "(^|\\/|\\\\)_" 
    }, 
    "plugins": [ "plugins/method" ], 
    "templates": { 
     "cleverLinks": false, 
     "monospaceLinks": false, 
     "default": { 
      "outputSourceFiles": true 
     } 
    }, 
    "jsVersion": 180 
} 

Und jetzt versuche ich, um das auf meine Vorlage zu bekommen. Ich bin auf method.tmpl.

Ich habe versucht:

self.find('methodHttp')[0] 
data.methodHttp[0] 
data.methodHttp 

Aber es funktioniert nicht. Was ist falsch an meinem Code?

Antwort

4

jsDoc.defineTag unterstützt keine Tags mit Groß char ...

Obwohl es ein Fehler in ihrem Wörterbuch zu sein scheint!