JDownloader.org - Offizielle Homepage
Diese Seite wurde noch nicht ins Deutsche übersetzt

Dokuwochen bei JDownloader

Unser Code ist leider sehr schlecht dokumentiert. Wir ALLE vernachlässigen das leider von Anfang an. Das soll JETZT ein Ende haben

Warum dokumentieren?

Weil wir Code schreiben, mit dem andere arbeiten wollen und sollen. Ihr seid sicherlich nicht der letzte der auf euren Code schaut und ihn verstehen muss.

Was soll dokumentiert werden?

Wir wollen nicht den Code dokumentieren, wir wollen dokumentieren warum der Code so geschrieben wurde wie er da steht. Im prinzip sollte jedes Feld und jede Methode dokumentiert werden.

Auserdem sollten alle Besonderheiten auch innerhalb von Codeblöcken dokumentiert werden. Überall wo einem der Sinn nicht sofort ins Auge springt.


Überspitztes Beispiel:

SCHLECHT:

//This is a variable
private int i;

BESSER:

/**
 * The Server domain.de bans your ip after 10 request. 
 * This is a countervariable for counting requests to domain.de
 * @see ServerConnecter#request
 */
private int i;

Wie dokumentieren?

  • Englisch! Besser schlechtes Englisch als gutes Deutsch. Niemand wird euch wegen schlechtem Englisch verurteilen.
  • JavaDoc für Methoden, Klassen, Konstanten und Felder. Nutze
    • {@link jd.Klasse#methode Beschreibung}
    • @see jd.Klasse#methode
    • Einfache html tags um das ganze hübsch und übersichtlich zu halten.
  • / / Kommentare für Anmerkungen innerhlab von Codeblöcken