Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

Editor Stil-Richtlinien

Einführung

Vielen Dank für Ihr Interesse, einen Beitrag zum Godot-Editor zu leisten!

Diese Seite beschreibt die Grammatik und den Schreibstil, die im gesamten Godot-Editor verwendet werden. Wenn Sie diese Stil-Richtlinien befolgen, wird Ihr Beitrag schneller gemergt, da weniger Review-Schritte erforderlich sind.

Schreibstil

  • Schreiben Sie Meldungen (Fehler, Warnungen, ...) in ganzen Sätzen. Sie sollten mit einem Großbuchstaben beginnen und mit einem Punkt enden.

  • Versuchen Sie, Sätze kurz zu halten. Das macht es wahrscheinlicher, dass ihre Übersetzungen ebenfalls kurz sind, was eine gute Sache ist, um UI-Bugs zu vermeiden.

  • Verwenden Sie Kontraktionen. Verwenden Sie z.B. "isn't" statt "is not". Eine Ausnahme von dieser Regel kann gemacht werden, wenn Sie eines der Wörter der Kontraktion besonders betonen wollen.

  • Verwenden Sie in Nachrichten doppelte Anführungszeichen ("") anstelle von einfachen Anführungszeichen (''). Doppelte Anführungszeichen sollten verwendet werden, um Benutzereingaben, Dateipfade und möglicherweise andere Dinge, je nach Kontext, zu zitieren.

Siehe auch

Versuchen Sie, zusätzlich zu den oben genannten Richtlinien die Leitlinien zum Schreiben zu befolgen.

Buttons und Menütexte

Schreiben Sie Texte in Buttons und Menüs groß:

  • gut: Open Editor Data Folder

  • schlecht: Open editor data folder

Wenn eine Menüaktion einen modalen Dialog öffnet, fügen Sie ihm ein Auslassungszeichen (...) hinzu.

  • Gut: Editor Settings...

  • schlecht: Editor Settings

Inspektor-Abschnitte

Generell sollten Sie keine Abschnitte erstellen, die weniger als 3 Elemente enthalten. Abschnitte, die nur wenige Elemente enthalten, erschweren die Navigation im Inspektor und verzichten auf die Vorteile von Abschnitten wie z.B. das Einklappen.

Es gibt einige gültige Ausnahmen, wie z.B. die Materialmerkmale in StandardMaterial3D.

Dieser Ratschlag gilt ebenso für die Projekteinstellungen und die Editoreinstellungen.

Inspektor-Performance-Tipps

Enum-Propertys, die sich merklich auf die Performance auswirken, sollten mit einem Performance-Hinweis versehen werden. Der Hinweis sollte sich auf die absolute Auswirkung auf die Performance beziehen und nicht relativ zu den anderen in der Aufzählung angegebenen Optionen sein. Hier sind einige Beispiele aus dem Godot-Editor:

  • Screen-space antialiasing: Disabled (Fastest), FXAA (Fast)

  • MSAA quality: Disabled (Fastest), 2x (Fast), 4x (Average), 8x (Slow), 16x (Slower)

  • DirectionalLight mode: Orthogonal (Fast), PSSM 2 Splits (Average), PSSM 4 Splits (Slow)

Versuchen Sie aus Gründen der Konsistenz, die folgenden Begriffe einzuhalten (vom schnellsten zum langsamsten):

  • Fastest, Faster, Fast, Average, Slow, Slower, Slowest

Ihre Verwendung muss nicht zusammenhängend sein. Sie können zum Beispiel nur "Fast" und "Slow" aus der obigen Liste verwenden.

Wenn Sie eine neue Aufzählung hinzufügen, sollten deren Werte von der schnellsten Option zur langsamsten Option sortiert werden.

Tooltips

Ziehen Sie in Erwägung, Tooltips hinzuzufügen, wenn die von einem Button oder einer Menüaktion ausgeführte Aktion nicht offensichtlich ist. Sie können im Tooltip auch zusätzlichen Kontext bereitstellen oder Vorbehalte hervorheben.

Sie können dies tun, indem Sie set_tooltip(TTR("Text here.")) auf dem betreffenden Control-basierten Node aufrufen. Wenn der Tooltip besonders lang ist (mehr als ~80 Zeichen), brechen Sie ihn über mehrere Zeilen um, indem Sie Zeilenumbrüche mit \n hinzufügen.

Tooltips sollten dem oben beschriebenen Schreibstil folgen. Verwenden Sie außerdem den Indikativ anstelle des Imperativs:

  • Gut: Computes global illumination for the selected GIProbe.

  • Schlecht: Compute global illumination for the selected GIProbe.