NetBeans javadoc mit Zeilenumbrüchen generieren

[Nobba]

Hallo Java-Gemeinde,

Ich versuche für mein Projekt gerade die Java-Docs aufzubessern.
Man kann ja im allgemeinen HTML-Tags in den Javadocs benutzen.

Hier hab ich allerdings ein Problem.

Ich arbeite mit Netbeans IDE 6.9.1 unter Ubuntu 10.10.

Also meine Fragestellung:

<br> funktioniert. Zeile wird umgebrochen, aber alle Zeilen werden in dem Inhaltsverzeichnis angezeigt.

<p> Hat keinen Effekt, funktioniert nicht.


Was habe ich vor:
Ich möchte Mehrere Absätze innnerhalb einer Javadoc Beschreibung erzeugen. So dass eine Überschrift in dem Inhaltsverzeichnis auftaucht und weiter unten in der Methodenerklärung weitere Absätze mit genaueren Angaben folgen. Die funktioniert leider nicht.

Beispiele meines Problems habe ich als Bilder angehängt.
Einmal das Javadoch. Hier habe ich versucht einmal durch <br> zu trennen und einmal durch <p> aber beide male wird der gesammte Java-doc Kommentar aus dem Quelltext in dem Inhaltsverzeichnis angezeigt.

Wäre wirklich hilfreich, wenn jemand eine Lösung wüsste.
Mit freundlichen Grüßen,
Nobba

 

[stareagle]

Hallo Nobba,

hast du mal versucht, die Absätze zu schließen? Sprich nicht nur ein Tag öffnen, sondern auch schließen.

Außerdem sollten, wenn du Absätze verwendest, alle Teile der JavaDoc in einem Absatz stehen.

Beispiel:

/**
  * <p>
  * Balligkeitsexzentrität
  * </p>
  * <p>
  * Normal 2 mm
  * </p>
  */
public static double EXB;

 

[Nobba]

Ich habe das mal ausprobiert. leider hat das keinen Effekt.
Ich finde, das irgendwie sehr merkwürdig, dass auf andere Html-Tags eingegangen wird wie _i usw. aber <p> nicht funktioniert.

Aber danke für die Antwort.

 

[stareagle]

Moin Nobba,

war mir gerade auffällt: Hinter Balligkeitsextentrität ist kein Punkt. Was passiert denn, wenn du folgendes schreibst:

/**
  * <p>
  * Balligkeitsexzentrität.
  * </p>
  * <p>
  * Normal 2 mm.
  * </p>
  */
public static double EXB;

Beste Grüße

Stareagle

 

[Nobba]

Hallo Stareagle,

Hey, der Punkt war wirklich die Lösung.

So funktioniert es.

Wie biste denn darauf gekommen. Ist schon einwenig merkwürdig, denn nicht mal ein Doppelpunkt funktioniert.
Das Entscheidungskriterium ist wirklich der Punkte.

Auf alle Fälle DANKE.
Jetzt kann ich wieder ruhig schlafen :toll:
Nobba

 

[maki]

[c]<pre>[/c] solltest du auch mal probieren

 

[stareagle]

Hallo Nobba,

gekommen bin drauf, als heute morgen in eine Java-Klasse mit Kommentaren geschaut habe. Dabei ist mir aufgefallen, dass ich überall einen Punkt hinter dem ersten Satz hatte, und auch nur dieser Teil des Kommentars in der Übersicht erscheint.

Beste Grüße

Stareagle

 

[Nobba]

Hi Stareagle,

Na <pre> hab ich schonmal ausprobiert gehabt, aber das funzt net.

Ich muss wohl jetzt den . in meine interne Liste der HTML-Tags aufnehmen

Gut das es so Foren gibt, von selber wär ich da nett draufgekommen und werd das die Tage auf jedenfall noch nen paar mal brauchen. Muss ne ordentliche Doc anlegen, damit mein Betreuer an der Uni ne Möglichkeit hat zu folgen was ich so die letzten Wochen fabriziert habe.

Grüße aus Dresden,
Nobba