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

Написание хорошего кода почти похоже на рассказ истории вашим читателям, важно, чтобы они понимали, что вы пытаетесь выразить через свой код. Итак, основные выводы из книги:

Функции

1. Аргументов не должно быть больше 2

2. Функция должна выполнять только свою собственную задачу, а не второстепенную задачу.

3. Длина функции не должна превышать 10–20 строк.

4. Избегайте дублирования действий, выполняемых функцией, т. е. сохраняйте их атомарными.

5. Часто это должно быть название глагола или глагольной фразы.

Комментарии

Код подобен юмору, если вам нужно его объяснить, это «плохо».

  1. Если вам приходится использовать обширные комментарии, значит, вы не понимаете свой собственный код.

2. Комментарии используются, когда программа не может объяснить, что она делает, и это противоречит цели ее написания.

3. Чистый код не требует комментариев, если только он не REGEX.

Имена классов и переменных

1. Имена переменных должны быть связаны с выполняемой задачей.

2. Не пишите случайные имена в качестве внутренней шутки или длинное бессвязное имя, которое потом будет трудно отредактировать.

3. Используйте произносимые имена

Использованная литература :

  1. http://geek-and-poke.com/
  2. «Как писать чистый код» Роберта Мартина