Wie generiert man JSDoc-Kommentare für Funktionen, wenn kein Kommentar existiert?

Question

Ich versuche ein Plugin für JSDoc zu erstellen. Ich folge der Dokumentation (was ironischerweise fehlt) und ich bin mir nicht sicher, wie ich das machen soll.

Mein Plugin ist richtig geladen, und ich versuche ein einfaches Beispiel. Hier ist mein Plugin (das lädt, weil ich einen Fehler aus, kann von dort jsdoc von Laufen zu stoppen):

visitNode: function(node, e, parser, currentSourceName) { 

    if(node.type === 109){ 
     if(!e.comment || e.comment ==="@undocumented"){ 

      var startComment = '/**', 
       endComment = '\n*/'; 
      var params = node.getParams(), 
       paramsComment = ''; 
      for(var i=0; i<params.length; i++){ 
       paramsComment += '\n* @param ' + params[i]; 
      } 

      e.comment = startComment + 
       paramsComment + 
       endComment; 
     } 
    } 

Bitte beachten Sie, dass node.type === 109 bis Token.FUNCTION äquivalent ist, die zur Verfügung stehen sollen wie in ihrem Beispiel here, aber Token ist im Plugin nicht definiert.

Wenn Sie von einer besseren Seite kennen, die erläutern, wie ein JSDoc Plugin zu schreiben, das wäre dann sehr viel zu schätzen ... dank

Answer 1

Ich hatte auch dieses Problem und es scheint seltsam, dass JSDoc nicht hat eine Art bereits gemachter Option dafür oder zumindest ein Plugin.

Wie auch immer, dieses Plugin hat mein Problem gelöst. Ich verwende JSDoc Version 3.4:

'use strict'; 
exports.handlers = { 

    symbolFound:function(e) { 
     if(e.astnode.type === "FunctionDeclaration") { 
      if((e.comment==="@undocumented")){ 
       e.comment = '/** undocumented */'; 
      } 
     } 
    } 
};