JavaScript Probleme mit JSDoc 3

[Finalspace]

Hallo,

kann mir jemand mal erklären was man bei JSDoc alles beachten muss, weil die Generierung von Dokumentationen meiner Quellcodes die alle bereits JSDoc Kommentare haben funktioniert überhaupt nicht. Entweder ich bekomme nichts raus - also alles Leer, oder ich hab mal Glück und er findet mal eine Funktion oder so...

Ich hab hier nen einfaches Beispiel, wo schon nicht funktioniert:

(function (root, factory) {
    if (typeof exports === 'object') {
        // Node, CommonJS-like
        module.exports = factory(root);
    } else {
        // Browser globals (root is window)
        root.szue = factory(root);
    }
}(this, function (global) {
    "use strict";

    /**
     * Log level enum
     * @readonly
     * @enum {number}
     */
    var LogLevel = {
        DEBUG: 0,
        INFO: 1,
        WARN: 2,
        ERROR: 3,
        FATAL: 4
    };

    /**
     * A static function
     * @param arg1 {number}
     * @param arg2 {string}
     */
    var staticFunction = function(arg1, arg2) {
    };

    /**
     * A circle class
     * @param radius {number}
     * @constructor
     */
    function Circle(radius) {
        /**
         * The radius of the circle
         * @property {number}
         */
        this.radius = radius;
    }

    /**
     * A static number
     * @type {number}
     */
    var staticNumber = 42;

    /**
     * A static string
     * @type {string}
     */
    var staticString = "Hello World";

    /**
     * My cool module
     * @exports szue
     */
    var szue = {
        LogLevel: LogLevel,
        staticFunction: staticFunction,
        staticNumber: staticNumber,
        staticString: staticString,
        Circle: Circle
    };

    return szue;
}));

Was ich erwarte ist dies:

LogLevel, staticFunction, staticNumber, staticString im Modul "szue" erscheint mit allen Informationen die ich ihm bereitgestellt habe. Ebenfalls Circle sollte zusätzlich als Klasse im Modul "szue" erkannt worden sein - inkl. dem radius Feld.

Was ich aber bekomme nach "jsdoc example.js" ist nen leeres Modul "szue" O_o

Interessant und aber merkwürdig zugleich ist, wenn ich z.b. meinem LogLevel Enum nen @name verpasse, dann erscheint das Enum zwar - aber ohne die Values... und das gleiche passiert auch wenn den funktionen ne @func oder @method verpasse. Sehr komisches verhalten.

Kann mir einer mal das erklären was ich hier falsch mache?

Danke,
Final

 

[Finalspace]

Ich habe es selber herausgefunden.

Pro Modul muss man nen @module block hinzufügen und jeder verdammte Codeteil muss ein @memberof module:meinmodulename haben, dann erscheint das auch als Methode, Klasse, Eigenschaft in der Doku. Allerdings nur, wenn beim Export auf etwas verweist und nicht implementiert.

Ist aber alles andere als Optimal, weil automatische Verlinkungen für Typen nicht funktioniert. Somit macht es die Dokumentation relativ nutzlos, weil man nicht einfach mal auf nen Typ oder Klasse klicken kann um direkt hinzuspringen. Ebenfalls muss man sich durch die Module klicken um andere Inhalte zu finden, wie z.b. Enumerationen, Statische Felder etc. :-(

Was lernt man daraus: Dokumentationsgenerator selber schreiben!