Javadoc for Javascript? Gibt es da Scanner?

[MudGuard]

Hi,

Wer Java kennt, kennt ja auch die typischen Kommentare a la

  
  /** search in lowercase HTML input  
     * @param str what to search for  
     * @param startIx where to start search  
     * @returns position of first hit or -1 if not found  
     */  
    private int caseInsensitveIndexOf(StringBuffer input, String str, int startIx)  
{  
   return 0;  
}  

die dann mit dem Javadoc-Generator zu einer übersichtlichen HTML-Seite zusammengebaut werden.

Für ein etwas umfangreicheres Javascript-Projekt würden wir das auch gerne benutzen.

Leider kommt der Javadoc-Generator aus Netbeans nicht mit Javascript zurecht - er stört sich daran, daß keine class vorhanden ist usw. (und läuft sowieso erst los, nachdem das File auf .java umbenannt wurde ...)

Kennt jemand ein Tool, das das gewünschte (javadoc-Kommentare im Javascript-File in die passende HTML umsetzen) leistet?

TIA

cu,
Andreas

[Eternius]

Hallo,

http://www.google.de/search?q=javascriptdoc&start=0&start=0&ie=utf-8&oe=utf-8
  evtl 1. Link?

gruss

[Eternius]

Hallo,

und daraus evtl auch http://jsdoc.sourceforge.net/.

gruss

[MudGuard]

Hi,

und daraus evtl auch http://jsdoc.sourceforge.net/.

Danke, das schaut doch schon mal gut aus.

Kleiner Haken: mein Chef mag Perl nicht ...
Aber das werd ich ihm schon noch unterjubeln.

cu,
Andreas

[Eternius]

Hi,

Kleiner Haken: mein Chef mag Perl nicht ...
Aber das werd ich ihm schon noch unterjubeln.

da lässt sich doch chefmässig argumentieren: die richtigen Werkzeuge/Sprachen für die Aufgabe.
  gut zu lesen fand ich da http://www.unixreview.com/documents/s=9846/ur0508o/

gruss

[MudGuard]

Hi,

und daraus evtl auch http://jsdoc.sourceforge.net/.

Hm. Funktioniert doch nicht so ganz wie gewünscht:

Wir haben relativ oft Konstrukte wie dieses:

  
var bla =  
{  
        /** test is a dummy function  
         * @param par1 first parameter  
         * @returns a returnable value  
         */  
      test: function(par1)  
        { return 1; }  
      ,  
        /** nochntest is a dummy function  
         * @returns a returnable value  
         */  
      nochntest: function()  
        { return 1 }  
}  

Also Sammlungen von eigentlich unabhängigen Funktionen, die zur Vermeidung von Namenskonflikten in ein "Objekt" verpackt werden.
Und die Javadoc-Kommentare da drin werden leider komplett ignoriert von JSDoc.

cu,
Andreas

[rob]

Hi!

Für ein etwas umfangreicheres Javascript-Projekt würden wir das auch gerne benutzen.

In welcher Sprache sollte das geschrieben sein? Ist das egal?

Kennt jemand ein Tool, das das gewünschte (javadoc-Kommentare im Javascript-File in die passende HTML umsetzen) leistet?

Also direkt für JS kenne ich da nichts. Es gibt aber PHPDoc.
Und da die Kommentare wie @return oder @param oder so ja gleich sind, sollte es wohl kein Problem sein, PHPDoc mit nur kleinen evtl. auch nur winzigen Modifikationen in ein JSDoc umzuschreiben.

Gruß, rob

[MudGuard]

Hi,

Für ein etwas umfangreicheres Javascript-Projekt würden wir das auch gerne benutzen.
In welcher Sprache sollte das geschrieben sein? Ist das egal?

Ist nicht allzu wichtig (ok, Cobol muß nicht sein ;-))- wobei mein Chef Java bevorzugen würde.

Also direkt für JS kenne ich da nichts. Es gibt aber PHPDoc.

Und es gibt auch JSDoc, siehe Posting von Eternius ;-)

cu,
Andreas

[Maxx]

Hallo Andreas,

Kennt jemand ein Tool, das das gewünschte (javadoc-Kommentare im Javascript-File in die passende HTML umsetzen) leistet?

Vielleicht ist doxygen etwas für dich.

Grüße,

Jochen

[MudGuard]

Hi,

Kennt jemand ein Tool, das das gewünschte (javadoc-Kommentare im Javascript-File in die passende HTML umsetzen) leistet?
Vielleicht ist doxygen etwas für dich.

Danke, werd ich mir angucken.

cu,
Andreas

[LanX!]

Hi

die dann mit dem Javadoc-Generator zu einer übersichtlichen HTML-Seite zusammengebaut werden.

Für ein etwas umfangreicheres Javascript-Projekt würden wir das auch gerne benutzen.

muss es Javadoc sein? Schau dir doch mal etwas über noweb zusammen mit dem leo-outliner als GUI an.

http://www.eecs.harvard.edu/~nr/noweb/
http://webpages.charter.net/edreamleo/front.html

der Vorteil wäre dass du Sprachenunabhängig wärst, d.h. nicht nur deine JS-Dateien sondern auch CSS und HTML in eine konsistente Beschreibungssprache hättest und unterschiedlichste Dokuformate generieren könntest.

Ich bin von dem Ansatz total fasziniert, momentan scheiterts nur daran dass an meiner Uni nur ein antiquiertes Python (für leo) installiert ist.

Tschau
 rolf

[MudGuard]

Hi,

die dann mit dem Javadoc-Generator zu einer übersichtlichen HTML-Seite zusammengebaut werden.
Für ein etwas umfangreicheres Javascript-Projekt würden wir das auch gerne benutzen.

muss es Javadoc sein? Schau dir doch mal etwas über noweb zusammen mit dem leo-outliner als GUI an.

Da wir hier auch sehr viel Java schreiben, sind wir Javadoc einfach gewohnt ;-)

http://www.eecs.harvard.edu/~nr/noweb/
http://webpages.charter.net/edreamleo/front.html

Guck ich mir auch an.

Sieht aber irgendwie ziemlich konfus aus.

cu,
Andreas

[LanX!]

Hi

Da wir hier auch sehr viel Java schreiben, sind wir Javadoc einfach gewohnt ;-)

Na dann solltet ihr dabei bleiben. wenn aber noch was dazu kommt, z.B perl wirds interessant.

Aber ich vermute ihr setzt eclipse ein mit entsprechenden Plugins für Javadoc.

Sieht aber irgendwie ziemlich konfus aus.

Ja, die Gestaltung von Homepages ist nicht die Stärke der Herren :)

Ich stecke in den Details nicht drinnen, aber ich denke Literate Programming geht _deutlich_ über die Möglichkeiten von sowas wie Javadoc und Perldoc hinaus.

Der Gedanke ist dass die gesamte Doku im Code eingebettet ist, mit extraktionen wird dann die Doku generiert, seis HTML, Latex oder was auch immer.

So wie Latex Knuth' Tex vereinfacht hat will noweb
Knuth' WEB praktikabel machen. Und die TeX selbst wurde damals mit WEB programmiert/dokumentiert.

Tschau
 rolf