Азбука соглашений об именах Dart: руководство для разработчиков

Привет, коллеги-разработчики! Сегодня мы собираемся погрузиться в захватывающий мир соглашений об именах Dart. Если вы новичок в Dart или просто хотите освежить свой стиль программирования, эта статья для вас. Мы рассмотрим ряд методов и лучших практик для именования переменных, функций, классов и многого другого. Так что возьмите свой любимый напиток, наденьте шляпу программиста и приступим!

  1. Верблюжий регистр или нижний верблюжий регистр.
    Одним из самых популярных соглашений об именах в Dart является верблюжий или нижний верблюжий регистр. Он широко используется для именования переменных, функций и переменных экземпляра. В верблюжьем регистре первая буква идентификатора начинается со строчной буквы, а первая буква каждого последующего составного слова начинается с прописной буквы. Например:

    var myVariable;
    void myFunction() {}
  2. Верблюжий регистр или регистр Pascal.
    Верблюжий регистр, также известный как регистр Pascal, обычно используется для именования классов, перечислений и определений типов. В этом соглашении первая буква каждого составного слова начинается с заглавной буквы. Например:

    class MyClass {}
    enum Color { red, green, blue }
    typedef Callback = void Function();
  3. Префикс подчеркивания.
    Префикс символа подчеркивания указывает на то, что он является личным для своей библиотеки или файла. В Dart принято отмечать частные переменные, функции и классы с помощью подчеркивания. Вот пример:

    var _privateVariable;
    void _privateFunction() {}
  4. ВСЕ ЗАГЛАВНЫЕ SNAKE CASE:
    ВСЕ ЗАГЛАВНЫЕ SNAKE CASE используются для констант или переменных, которые должны рассматриваться как константы. В этом соглашении слова разделяются подчеркиванием, а все буквы пишутся с заглавной буквы. Например:

    const MAX_VALUE = 100;
    final PI = 3.14;
  5. Сокращения.
    При использовании сокращений обычно рекомендуется писать все буквы сокращения с заглавной буквы. Например:

    var httpURL;
    var userID;
  6. Именование глагол-существительное.
    Для функций или методов, выполняющих действие, общепринятым соглашением является использование формата глагол-существительное. Это помогает передать цель функции. Например:

    void saveData();
    void fetchData();
  7. Логические значения.
    В Dart существует соглашение об именовании переменных, представляющих логические значения. Обычно используется префикс типа «is» или «has», чтобы указать, что переменная представляет состояние «да/нет» или «истина/ложь». Например:

    bool isReady;
    bool hasPermission;
  8. Имена во множественном и единственном числе.
    Для коллекций или списков рекомендуется использовать имена во множественном числе, чтобы указать, что они содержат несколько элементов. Для единичных экземпляров предпочтительны имена в единственном числе. Например:

    var users = [];
    var user = User();

Помните, что соблюдение соглашений об именах помогает улучшить читаемость и удобство обслуживания кода. Последовательность – это ключ к именованию вашего кода Dart, поэтому выберите соглашение и придерживайтесь его на протяжении всего проекта.

На этом наш обзор соглашений об именах Dart завершается. Мы рассмотрели некоторые из наиболее часто используемых соглашений, но помните, что гибкость важна, и вам всегда следует учитывать конкретные рекомендации вашего проекта или команды. Приятного кодирования!