Керівництво по стилю редактора

Вступ

Дякуємо за ваш інтерес до участі в редакторі Godot!

На цій сторінці описано граматику та стиль написання, які використовуються в редакторі Godot. Дотримуючись цього посібника зі стилю, ваш внесок буде об’єднано швидше, оскільки потрібно буде менше кроків перегляду.

Стиль написання

  • Пишіть повідомлення (помилки, попередження, ...) повними реченнями. Вони мають починатися з великої літери та закінчуватися крапкою.

  • Намагайтеся, щоб речення були короткими. Це збільшує ймовірність того, що їхні переклади також будуть короткими, що добре, щоб уникнути помилок інтерфейсу користувача.

  • Використовуйте скорочення. Наприклад, використовуйте «не» замість «не». Виняток із цього правила можна зробити, коли ви спеціально хочете підкреслити одне зі слів скорочення.

  • Використовуйте подвійні лапки в повідомленнях ("") замість одинарних лапок (''). Подвійні лапки слід використовувати для введення даних користувача, шляхів до файлів і, можливо, інших речей, залежно від контексту.

Дивись також

Намагайтеся дотримуватись Інструкції з написання на додаток до вказівок, викладених вище.

Тексти кнопок і меню

Пишіть великими літерами текст у кнопках і діях меню:

  • Добре: Відкрити папку даних редактора

  • Погано: Відкрити папку даних редактора

Якщо дія меню відкриває модальне діалогове вікно, додайте до нього крапку (...).

  • Добре: Налаштування редактора...

  • Погано: Налаштування редактора

Розділи інспектора

Загалом, не створюйте розділи, які містять менше 3 елементів. Розділи, які містять невелику кількість елементів, ускладнюють навігацію інспектора, втрачаючи при цьому переваги використання розділів, наприклад складання.

Існують деякі дійсні винятки для цього, як-от особливості матеріалу в StandardMaterial3D.

Ця порада також стосується налаштувань проекту та налаштувань редактора.

Підказки щодо роботи інспектора

Властивості Enum, які помітно впливають на продуктивність, повинні мати пов’язану підказку щодо продуктивності. Підказка має стосуватися абсолютного впливу на продуктивність, а не відносно інших параметрів, наданих у переліку. Ось кілька прикладів із редактора Godot:

  • Згладжування екранного простору: Вимкнено (найшвидше), FXAA (швидко)

  • Якість MSAA: Вимкнено (найшвидший), 2x (швидкий), 4x (середній), 8x (повільний), 16x (повільніший)

  • Режим DirectionLight: Ортогональний (швидкий), PSSM 2 розділення (середній), PSSM 4 розділення (повільний)

Для послідовності спробуйте дотримуватися наведених нижче термінів (від найшвидшого до найповільнішого):

  • Найшвидший, Швидший, Швидкий, Середній, Повільний, Повільніший, Найповільніший

Їх використання не повинно бути суміжним. Наприклад, зі списку вище можна використовувати лише «Швидко» та «Повільно».

Якщо ви додаєте новий перелік, його значення слід упорядкувати від найшвидшого до найповільнішого.

Підказки

Подумайте про додавання підказок, якщо дія, що виконується кнопкою чи меню, неочевидна. Ви також можете надати додатковий контекст або виділити застереження у спливаючій підказці.

Ви можете зробити це, викликавши set_tooltip(TTR("Text here.")) на відповідному вузлі на основі Control. Якщо спливаюча підказка дуже довга (понад ~80 символів), розмістіть її на кількох рядках, додавши розриви рядків за допомогою \n.

Підказки мають відповідати стилю написання, описаному вище. Крім того, вживайте вказівний спосіб замість наказового:

  • Добре: Обчислює глобальне освітлення для вибраного GIProbe.

  • Погано: Обчислити глобальне освітлення для вибраного GIProbe.