Package mit JavaDoc dokumentieren

Screenshot JavaDoc Möchte man mit JavaDoc ein Package dokumentieren, legt man im entsprechenden Source-Ordner eine Datei package.html an. Des weiteren kann man seine Dokumentation durch beliebige andere Files (z.B. Bilder) erweitert. Zu diesem Zweck legt man die Dateien in einem Order doc-files ab. Der Bezug innerhalb der Dokumentation wird dann über relative Pfade realisiert (z.B. <img src="doc-files/package.png">).

How to Write Doc Comments for the Javadoc Tool

Reference Guide

Code Conventions for the Java

Kurzbeschreibung: javadoc

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.

Diese Website verwendet Akismet, um Spam zu reduzieren. Erfahre mehr darüber, wie deine Kommentardaten verarbeitet werden.