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 zusammengeführt, da weniger Überprüfungsschritte 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, die 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 Richtlinien Dokumentation schreiben zu befolgen.

Schaltflächen und Menü Texte

Großschreibung von Texten in Schaltflächen und Menüs:

  • gut: Editor Datenverzeichnis öffnen
  • schlecht: Editor Datenverzeichnis öffnen

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

  • Gut: Editoreigenschaften...
  • schlecht: Editoreigenschaften

Inspector Sektion

Generell sollten Sie keine Abschnitte erstellen, die weniger als 3 Elemente enthalten. Abschnitte, die nur wenige Elemente enthalten, erschweren die Navigation im Inspektor und lassen die Vorteile der Verwendung von Abschnitten wie z. B. das Falten vermissen.

Es gibt einige gültige Ausnahmen hierfür, z.B. Materialeigenschaften in SpatialMaterial.

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

Inspector Leistungs Tipps

Enum-Eigenschaften, die sich merklich auf die Leistung auswirken, sollten mit einem Leistungshinweis versehen werden. Der Hinweis sollte sich auf die absolute Auswirkung auf die Leistung 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: Deaktiviert (am schnellsten), FXAA (schnell)
  • MSAA-Qualität: Deaktiviert (am schnellsten), 2x (schnell), 4x (durchschnittlich), 8x (langsam), 16x (noch langsamer)
  • Richtungslichtmodus: Orthogonal (schnell), PSSM 2 Splits (durchschnittlich), PSSM 4 Splits (langsam)

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

  • schnellster, schneller, schnell, durchschnittlich, langsam, langsamer, langsamste

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

Wenn Sie eine neue Enumeration hinzufügen, sollten deren Werte von der schnellsten Option zur langsamsten Option geordnet werden.

Tooltips

Ziehen Sie in Erwägung, Tooltips hinzuzufügen, wenn die von einer Schaltfläche oder 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 hier.")) auf dem betreffenden Control-basierten Node aufrufen. Wenn der Tooltip besonders lang ist (mehr als ~80 Zeichen), umbrechen Sie ihn über mehrere Zeilen, indem Sie Zeilenumbrüche mit \n hinzufügen.

Tooltips sollten dem oben beschriebenen Schreibstil folgen. Verwenden Sie außerdem die indikative Stimmung anstelle der imperativen Stimmung:

  • Gut: berechnet globale Beleuchtung für die ausgewählte GIProbe.
  • Bad: Berechnet die globale Beleuchtung für die ausgewählte GIProbe.