Комментарии проекта Корсары

Дмитрий Бушуев, …
Корсары

Рекомендации

Это заключительный урок данного цикла. Здесь я дам некоторые советы, которые помогут вам писать понятный, читаемый код.
Подстатья
7 окт 2024
15 133
0
Показать
30
0
Показать
EugeAl, если ты назвал функцию ships то сам себе злобный Буратина. Но адекватный пример придумать несложно - nearestShips это массив кораблей или функция по их получению?
Но именование функций с маленькой буквы это устоявшаяся практика, ничего зазорного в этом нет.
0
Показать
23
0
Показать
Во-первых, имена переменных начинаются с буквы в нижнем регистре. Если имя переменной состоит из одного слова, то это слово должно быть записано в нижнем регистре
...
Имена функций, как правило, начинаются с буквы в нижнем регистре
А как читающему кодеру отличать, например переменную ships (предположим, что она хранит текущее кол-во кораблей на карте) от функции ships (допустим, она спавнит группу кораблей на карту)?
Это ж действительно какой-то "ниндзя код" получается - ещё разбираться, что там после названия написано, а не сразу по названию понять.
С функциями в верхнем регистре таких проблем не будет...
0
Показать
24
0
Показать
ScorpioT1000:
Есть множество способов разделять области видимости - префиксы, модули, CRUD наборы функций, акцессоры, мутаторы, структуры.
Я с этим полностью согласен.
Но есть одна проблема.
Из всего перечисленного в скрипты Корсаров завезли только венгерскую нотацию.
И я ее рекомендовал только для глобальных переменных. Которых я вообще использовать не рекомендую.
Можно, конечно, без подчеркивания. Просто букву g. С доступными типами, в принципе, не пересекается 🤔
0
Показать
38
0
Показать
Венгерская нотация - это не только мусор и шум в коде, но еще и лишняя трата времени как на код, так и на рефакторинг.
Никогда не используйте венгерскую нотацию в типизированных языках
Есть множество способов разделять области видимости - префиксы, модули, CRUD наборы функций, акцессоры, мутаторы, структуры. Нет ни одной проблемы, которую бы решала эта нотация в долгосрочных перспективах
это моё личное мнение
Те, кто советует венгерскую нотацию, слишком мало рефакторил конструкции вида
g_myStruct.m_lpMySub.pszMyString
На новые типы данных
До статьи:
struct VectorNode {
  float x;
  float y;
  float z;
  PointNode * next;
}

VectorNode * nodes;

void VectorNodeInit(VectorNode * nodes, unsigned int count)
После статьи:
struct VectorNode {
  float fX;
  float fY;
  float fZ;
  PointNode * m_lpNext;
}

VectorNode * g_lpNodes;

void g_fnVectorNodeInit(VectorNode * lpNodes, unsigned int u32Count)
numberOfChars
Не правильно.
g_nNumberOfChars
0
Показать
30
0
Показать
avuremybe, это реальный боевой пример такого форматирования кода.
0
Показать
24
0
Показать
nazarpunk, опять утрируеш
0
Показать
30
0
Показать
Используйте пробелы и пропуски строк между стейтментами для улучшения читабельности вашего кода:
Вот пример, к чему такое может привести.
Загруженные файлы
1
Показать
30
1
Показать
avuremybe, для начала нужно постичь Ниндзя-код.
0
Показать
24
0
Показать
nazarpunk, предложи более корректную формулировку - я добавлю в статью.
0
Показать
30
0
Показать
avuremybe:
Запускать приложение.
Задача любой другой функции поддерживать работоспособность приложения. Так что любая функция выполняет ровно одну задачу по такой логике.