Dokumentiere eine Konstante mit ngDoc

8

Wie würde man eine Konstante mit ngDoc dokumentieren? Ich sehe keine winkelspezifische Dokumentation zur Dokumentation von Werten, die mit .constant registriert wurden, und die jsDoc-Syntax für Konstanten scheint keine tatsächlichen Dokumente zu generieren, wenn sie über ngDoc ausgeführt wird.

Beispiel:

/** * @constant * @name WHITE * * @description * The color white! **/ module.constant( 'WHITE', '#fff' );

    
dherman 06.08.2014, 15:06
quelle

2 Antworten

3

ngDocs bietet derzeit keine Möglichkeit, Konstanten zu dokumentieren. Wie Sie in seinem Templating-Quelltext sehen können. Es gibt keine relevante Methode html_usage_* .

Ich dokumentiere Konstanten wie diese, sie zeigt dann eine APP_CONFIG als Modul.

%Vor%     
zbycz 19.03.2015 14:32
quelle
-2

Es sollte @const sein

%Vor%

Siehe den konstanten Teil Ссылка und den Kommentarteil Ссылка für weitere Informationen

    
Kourkis 06.08.2014 15:14
quelle

Tags und Links