Eine eckige App mit einer Factory, die eine Klasse als solche zurückgibt:
%Vor% Wie kann ich mithilfe von ngdoc (der speziellen Variante von jsdoc angular uses) den Initialisierer dokumentieren, ohne ihn als Methode zu definieren?
Genau jetzt habe ich es versucht:
%Vor% Aber das führt dazu, dass der Initiator User (die Funktion User , die den Parameter name akzeptiert) wie eine Methode mit dem Namen Initializer behandelt wird, was für Leute, die versuchen, diesen Code zu verwenden, verwirrend ist / p>
Ich habe versucht, das @constructor -Flag hinzuzufügen, aber das hat keine Auswirkungen auf den HTML-Code . dgeni endet beim Generieren
Danke.
UPDATE : Verweise auf dgeni wurden entfernt. Ich hatte den Eindruck, dass das Plugin, das ich verwendete ( grunt-ngdocs ), dgeni hinter den Kulissen verwendet, aber das ist nicht der Fall.
Dies ist eine eigensinnige Antwort.
Ich hatte Probleme mit der Angular-Dokumentation, und ich schrieb sogar einen Blog darüber Seigh, AngularJS Documentation
Meine Schlussfolgerung war, eine neue zu bauen. Angular-jsdoc ist das Ergebnis.
Hier sind Auszüge aus GitHub.
JSDoc 3 Template für AngularJS.
Ein JSDoc Plugin und Template für AngularJS, sonst nichts!
Ich habe eine fork / pull-Anfrage erstellt, um @constructor-Unterstützung zu gulp-ngdocs hinzuzufügen, wie in grunt-ngdocs verfügbar: Ссылка . All dies ändert den grundlegenden Verwendungsabschnitt, um das neue Schlüsselwort aufzunehmen.
Verwenden Sie dann ähnlich, aber etwas anders als @ SGD's Antwort. Stellen Sie sicher, dass die @ ngdoc-Direktive für den Dienst die Funktion angibt.
Beispiel:
%Vor%Tags und Links javascript angularjs documentation jsdoc ngdoc