Russian Qt Forum
Апрель 20, 2024, 14:43 *
Добро пожаловать, Гость. Пожалуйста, войдите или зарегистрируйтесь.
Вам не пришло письмо с кодом активации?

Войти
 
  Начало   Форум  WIKI (Вики)FAQ Помощь Поиск Войти Регистрация  

Страниц: [1] 2 3   Вниз
  Печать  
Автор Тема: Чистый код: как правильно называть члены структур  (Прочитано 17094 раз)
YvenTitan
Самовар
**
Offline Offline

Сообщений: 174


Просмотр профиля
« : Октябрь 20, 2017, 13:12 »

Здравстуйте,
Есть мнение, что члены классов должны начинаться с m_
Как считаете, к членам структур это правило должно относиться?
Записан
ViTech
Гипер активный житель
*****
Offline Offline

Сообщений: 858



Просмотр профиля
« Ответ #1 : Октябрь 20, 2017, 13:45 »

Сначала нужно определиться чем структура отличается от класса, в понимании чистого кода Улыбающийся.

Коротко моё мнение: если структура не инвариант, все поля публичные, нет всяких геттеров/сеттеров, то префикс/суффикс не нужен.
Записан

Пока сам не сделаешь...
YvenTitan
Самовар
**
Offline Offline

Сообщений: 174


Просмотр профиля
« Ответ #2 : Октябрь 20, 2017, 13:53 »

Я не до конца понимаю, зачем писать префикс в членах класса. Я делаю по 2 причинам: во-первых, принято, признак хорошего тона; во-вторых, если вижу префикс, то сразу понимаю, что член класса и немного удобнее разбирать код.

Не знаю, чем отличаются в понимании чистого кода, может смысл закрытости членов класса...

У меня "геттеров/сеттеров" нет, не инвариант
Записан
ViTech
Гипер активный житель
*****
Offline Offline

Сообщений: 858



Просмотр профиля
« Ответ #3 : Октябрь 20, 2017, 14:04 »

Я не до конца понимаю, зачем писать префикс в членах класса. Я делаю по 2 причинам: во-первых, принято, признак хорошего тона; во-вторых, если вижу префикс, то сразу понимаю, что член класса и немного удобнее разбирать код.

Пара причин для примера:
1. С префиксами нет конфликтов имён с геттерами.
2. В IDE в автодополнении они сгруппированы, по "m_" можно увидеть список членов класса.
Записан

Пока сам не сделаешь...
Racheengel
Джедай : наставник для всех
*******
Offline Offline

Сообщений: 2679


Я работал с дискетам 5.25 :(


Просмотр профиля
« Ответ #4 : Октябрь 20, 2017, 16:58 »

Я не пишу, т.к. у структуры все мемберы публичны.
Если нужны геттеры - делайте класс тогда.
Записан

What is the 11 in the C++11? It’s the number of feet they glued to C++ trying to obtain a better octopus.

COVID не волк, в лес не уйдёт
deMax
Хакер
*****
Offline Offline

Сообщений: 600



Просмотр профиля
« Ответ #5 : Октябрь 21, 2017, 13:08 »

Пара причин для примера:
1. С префиксами нет конфликтов имён с геттерами.
2. В IDE в автодополнении они сгруппированы, по "m_" можно увидеть список членов класса.
имхо, геттеры лучше начинать с get.
автодополнение актуально только внутри методов класса(а там и так не так много методов), т.к. публичные члены для класса лучше не делать.
Записан
Авварон
Джедай : наставник для всех
*******
Offline Offline

Сообщений: 3258


Просмотр профиля
« Ответ #6 : Октябрь 21, 2017, 19:19 »

Здравстуйте,
Есть мнение, что члены классов должны начинаться с m_
Как считаете, к членам структур это правило должно относиться?

Уже написали в принципе - префикс добавляется к мемберам, чтобы избежать коллизии с геттером:
a.value(); // геттер
a.setValue(); // сеттер
a.m_value; // мембер

Я лично предпочитаю писать не m_value (как в венгерской нотации), а _value. Еще есть вариант с постфиксом value_, но мне он кажется безобразным (value_->foo()) - _value->foo()->bar() встречается гораздо чаще, чем a->_foo->_bar (тоже ужасно, но внутрь привата лезешь редко).

Еще есть вариант с d-pointer'ом: T value() const { return d->value; }
Записан
deMax
Хакер
*****
Offline Offline

Сообщений: 600



Просмотр профиля
« Ответ #7 : Октябрь 22, 2017, 13:24 »

Уже написали в принципе - префикс добавляется к мемберам, чтобы избежать коллизии с геттером:
a.value(); // геттер
a.setValue(); // сеттер
a.m_value; // мембер
имхо:
a.value; // мембер
a.setValue(); // сеттер
a.getValue(); // геттер
геттер это метод, действие, глагол, а не существительное. И если в классе слишком много member, setMember, getMember - то напрашивается сделать класс структурой, или разделить класс на структуру и класс.

getValue() - сразу видно что это геттер.
value() - это некая функция возвращающая значение, непонятно что делающая(просто взять значение или вычислить).
toValue() - преобразование

m_ подкупает автодополнением, но в принципе IDE сама могла бы подсказывать и фильтровать дополнения(например при автодополнении ctrl+M только методы...).
« Последнее редактирование: Октябрь 22, 2017, 13:30 от deMax » Записан
ssoft
Программист
*****
Offline Offline

Сообщений: 579


Просмотр профиля
« Ответ #8 : Октябрь 23, 2017, 12:37 »

Последнее время (лет 5) взял за правило обязательно использовать префикс для членов класса m_ и ни капли не жалею. Читабельность кода вырастает, саппорт и дальнейший разбор облегчается.
Кроме коллизий с геттерами могут быть и коллизии и с параметрами методов, и с локальными переменными. Когда требуется анализ кода без подсветки синтаксиса префикс сильно помогает.
Записан
__Heaven__
Джедай : наставник для всех
*******
Offline Offline

Сообщений: 2130



Просмотр профиля
« Ответ #9 : Октябрь 23, 2017, 14:07 »

Предпочитаю classMember_ и structMember.
Записан
YvenTitan
Самовар
**
Offline Offline

Сообщений: 174


Просмотр профиля
« Ответ #10 : Июнь 05, 2018, 10:13 »

Что можно сделать, чтобы избежать коллизии с параметрами конструктора? Нормально в конец имени члена добавить "_" или правильнее произвольно поменять имя параметра конструктора?
Например,

class Example
{
  int param1_;
  int param2_;

  Example(int param1, int param2)
  {
     param1_ = param1;
     param2_ = param2;
  }
}
Записан
Авварон
Джедай : наставник для всех
*******
Offline Offline

Сообщений: 3258


Просмотр профиля
« Ответ #11 : Июнь 05, 2018, 11:08 »

param1(param1)
Записан
kambala
Джедай : наставник для всех
*******
Offline Offline

Сообщений: 4727



Просмотр профиля WWW
« Ответ #12 : Июнь 05, 2018, 11:09 »

приватные переменные обычно имеют префикс _ или m_. Для публичных можно в параметры конструктора в конец добавить _
Записан

Изучением C++ вымощена дорога в Qt.

UTF-8 has been around since 1993 and Unicode 2.0 since 1996; if you have created any 8-bit character content since 1996 in anything other than UTF-8, then I hate you. © Matt Gallagher
Пантер
Administrator
Джедай : наставник для всех
*****
Offline Offline

Сообщений: 5876


Жаждущий знаний


Просмотр профиля WWW
« Ответ #13 : Июнь 05, 2018, 11:16 »

У меня все мемберы приватные, именуются вот так someName_, коллизии с параметрами не возникает, ибо параметры именуются someName.
Записан

1. Qt - Qt Development Frameworks; QT - QuickTime
2. Не используйте в исходниках символы кириллицы!!!
3. Пользуйтесь тегом code при оформлении сообщений.
YvenTitan
Самовар
**
Offline Offline

Сообщений: 174


Просмотр профиля
« Ответ #14 : Июнь 05, 2018, 11:26 »

Извините, опечатался. Структура и все параметры публичные

struct Example
{
  int param1_;
  int param2_;

  Example(int param1, int param2)
  {
     param1_ = param1;
     param2_ = param2;
  }
}
Записан
Страниц: [1] 2 3   Вверх
  Печать  
 
Перейти в:  


Страница сгенерирована за 0.054 секунд. Запросов: 23.