Чистый код и язык программирования.pptx

Чистый код и язык программирования

1. Чистый код «Чистый код» чистый как кот

2. Всегда пишите код так, будто сопровождать его будет склонный к насилию психопат, который знает, где вы живете. Martin Golding Программы должны писаться для людей, которые будут их читать, а машины, которые будут эти программы исполнять — второстепенны . Harold Abelson

3. Чистый код – это само совершенство

4. “Чистый код всегда выглядит так, будто его писал человек, которому не всё равно”». Майкл Фезерс Этика хорошего программиста

5. Этика при программировании

6. Или интеллигентные программисты

7. Разработчиков хлебом не корми, дай поспорить о чистоте кода. Но при этом у самого понятия «чистый код» нет чёткого определения. Главная книга по этому вопросу — « Clean Code » , где Роберт «Дядюшка Боб» Мартин сразу заявляет: «сколько программистов, столько и определений».

8. Искусство комментировать или Зачем писать Комментарии к коду

9. - До начала матча — пять минут, счет по-пpежнему 0:0. - И мяч, преодолев последнее препятствие между ног вpатаpя , влетает-таки в воpота . Что такое комментарии - С мячом немцы, в данном случае — фpанцуз .

10. Комментарии это неотъемлемая часть в языках программирования Комментарии есть во всех языках программирования

11. «Хороший код является самодокументированным » Она истинна ? Да . Означает ли она, что вы никогда не должны комментировать код? Нет . Известная фраза:

12. var moiTovari; var cena; var ssilka; Название переменных var myGoods ; var price; var link; Лучше так не делать Профессионально

13. getUserName () — что-то произойдёт, и функция вернёт имя пользователя; Название функций

14. /* * Replaces with spaces * the braces in cases * where braces in places * cause stasis. **/ $ str = str_replace (array( "\{" , "\}" ), " " ,$ str ); Юмор программистов Заменяет пробелами фигурные скобки в тех случаях, когда скобки в некоторых местах вызывают «закупорки».

15. Юмор программистов Exception up = new Exception ( "Something is really wrong." ); throw up; Примечание. Исключения (исключительные ситуации, exceptions ) являются механизмом обработки ошибок.

16. Юмор /* Когда я начинал писать этот код, только Бог и я понимали, что он делает. Сейчас остался только Бог */ *** /* пьян, исправить позже */ *** /* Магия. Не трогать. */

17. /* set the value of the age integer to 32 */ int age = 32 ; Капитан очевидность Бессмысленные комментарии

18. Когда пытаешься разобраться в чужом коде

19. Чтобы такого не было, не ленитесь оставлять комментарии Вывод

20. Подытожим…. Зачем писать комментарии к коду?

21. Зачем писать Комментарии к коду 1. Помощь себе в будущем. Чтобы в будущем не тратить время на разбирательства, как работает этот велосипед. Используйте простое правило: оставляю комментарии в коде там, где они сэкономят мне время когда я буду читать этот код через год, уже разумеется не помня как и почему я его писал и что он делает. 2. Думаешь о других, о возможности рефакторинга твоего кода другим человеком. Этика хорошего программиста

22. /* don't use the global isFinite () because it returns true for null values */ Number .isFinite (value) Экономим время другим Простой пример в JavaScript:

23. Зачем писать Комментарии к коду Бывают куски кода/логики, которые всегда лучше с комментариями: 1. Оптимизации — краткое пояснение « это более быстрая версия вот этого», чтобы у других программистов не было желания переписать на более простую, но медленную версию. 2. Нетривиальная математика — краткое описание «этот алгоритм делает то - то, то - т о » или указание (хотя бы) названия алгоритма могут сэкономить много времени читающего. Особенно это актуально когда в алгоритме есть специфичные модификации. 3. Костыли — бывает так, что нет времени/возможности/сиюминутной необходимости сделать хорошо. С комментарием хоть будет понятно на что обратить внимание и что в первую очередь переделывать при работе с этим куском кода

24. Как правильно писать комментарии?

25. Существует два разных вида комментариев Документирующие комментарии (поясняют суть, назначение скрипта, функции, метода) Поясняющие комментарии

26. Во-первых, на уровне библиотек/программ/функций комментарии отвечают на вопрос « ЧТО ?» : «Что делают эти библиотеки/программы/функции? Документирующие комментарии

27. библиотека

28. Сперва Рационально? Логично?

29. Затем Рационально? Логично?

30. Рационально? Логично?

31. Во-вторых, поясняем входные и выходные аргументы функции Документирующие комментарии Пример. Документирование кода в Python . PEP 257 PEP 257 описывает соглашения, связанные со строками документации P ython , рассказывает о том, как нужно документировать ython код . Цель этого PEP - стандартизировать структуру строк документации: что они должны в себя включать, и как это написать.

32. В коде отвечают на вопрос « КАК ?» : « Как код (фрагмент кода) выполняет задание ? Поясняющие комментарии Пример

33. Примеры плохих и хороших однострочных комментариев:

34. Отвечают на вопрос « ПОЧЕМУ ?» : « Почему код выполняет задание именно таким образом, а не другим?» Поясняющие комментарии Пример

35. Примеры плохих и хороших однострочных комментариев:

36. Примеры плохих и хороших однострочных комментариев:

37. Примеры плохих и хороших однострочных комментариев: Программистам часто приходится принимать трудные решения по поводу того, каким способом решить проблему. А комментарии и существуют для того, чтобы напомнить себе (или объяснить другим) причину, почему вы написали код именно так, а не иначе.

38. Документирующие комментарии

39. Творить (писать) программу для других – красиво и интересно, чтобы другим было приятно ее читать Не лениться делать комментарии Соблюдайте аккуратность во всем, в том числе в написании кода Чистота Лаконичность Структурированность (все по атомам составляющим – важен каждый) – все вместе целостность и Высшая форма Заключение

40. Отношение к разработке программ это дело индивидуальное, но настоящие профессионалы/мастера своего дела относятся к ремеслу серьезно, ответственно, с любовью. Да ладно, и так сойдет