Skip to content

javadoc (API-Dokumentation)

Im Subprojekt build-tools befindet sich eine CSS-Datei, die verwendet wird, um das Aussehen der Dokumentation mit den Engine-Pi-Farbe (Gnome-Farben) und der Engine-Pi-Standard-Schrift (Cantarell) anzupassen.

Eigene CSS-Klassen

.development-note

Abfolge der Tags

Wir folgenden der Empfehlung, die im Artikel How to Write Doc Comments for the Javadoc Tool von Oracle dargestellt wird.

  1. @author (classes and interfaces only, required)
  2. @version (classes and interfaces only, required. See footnote 1)
  3. @param (methods and constructors only)
  4. @return (methods only)
  5. @throws (a synonym added in Javadoc 1.2 @exceptions)
  6. @see
  7. @since
  8. @deprecated (see How and When To Deprecate APIs)

Code Beispiele

Einzeilig

/**
 * {@code System.out.println("Lorem ipsum");}
 */

Mehrzeilig:

/**
 * <pre>
 * {@code
 * Set<String> s;
 * System.out.println(s);
 * }
 * </pre>
 */

Deutsche Übersetzungen von englischen Klassennamen

englisch deutsch
AABB (axis-aligned bounding box) achsenparallelen Begrenzungsrahmen
Actor Figur
BodyType Verhalten einer Figur in der physikalischen Simulation
Bounds Schranken, Abgrenzung
Controller Steuerung
DistanceJoint Stabverbindung
Fixture Halterung, Kollisionsform
Frame Einzelbild
Handler Steuerungsklasse
Joint Verbindung
Layer Ebene
Listener Beobachter
Loop Schleife
Offset Verzug
PrismaticJoint Federverbindung
Rectangle Rechteck
RevoluteJoint Gelenkverbindung
Rigid Body Starrer Körper
RopeJoint Seilverbindung
Scene Szene
Shape Umriss
Square Quadrat
TurboFire Dauerfeuer
WeldJoint Schweißnaht

Kommentar mit Lizenzhinweis

/*
 * Engine Pi ist eine anfängerorientierte 2D-Gaming Engine.
 *
 * Copyright (c) 2026 Josef Friedrich and contributors.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */