Quellcode kommentieren

[Guest]

hallo,

habe grade ein kleines Progrämmchen eschrieben und auuch schon mit dem kommentieren des Codes angefangen.

nun habe ich beim durchstöbern anderer Kommentare gesehen, das einzelne Worte manchmal kursiv, fett sind oder links verbergen.

Das hätte ich gerne auch an manchen Stellen, wie mache ich das? Sind das HTML Tags und gibts villeicht irgendwo ne kleine Übersicht über die gebräuchlisten Tags welche zum Quellcode kommentieren verwendet werden.

Also zum proggen verwende ich eclipse und de doc wollte dann über Generate javadoc im Projekt menu erstellen.

Wäre wirklich gut wenns sowas gebe oder mir jemand die tags aufschreiben könnte welche er verwendet.

 

[@x.l]

Ja es ist HTML!

SelfHTML hier findest du alle möglichen Tags.

Allzuviel brauch man nicht:
- fett
- kursiv
<u> - unterstrichen

 

[SnooP]

Ich verwende eigentlich nur <code>xyz</code> wenn ich z.B. ne Klasse oder nen Parameter innerhalb des Javadocs hervorheben möchte... zu mehr bin ich zu faul

 

[maki]

Quelltext kommentieren: Pfui!
Besser: JavaDoc einsetzen

Ich nehme aber an, dass du letzteres meintest

 

[Gast]

Ja genau, und wie kann ich einen link erstellen zu einer anderen Klasse. Also das einfach nur eim Text der klassenname zu sehen ist, welcher aber wie bei einem link typisch blau und unterstrichen ist.

z.b die klasse zu der ich verlinken will heiß Person und befindet sic im package model.

 

[maki]

{@link Klasse}

http://java.sun.com/j2se/javadoc/writingdoccomments/

 

[Gast]

Danke funktioniert gut, geht das verlineken auch auf ne klassenvariable