Юрий Орлов "Практика принятия и применения Coding сonventions в разработке"

Задача данного доклада – объяснить, для чего же все-таки нужны на первый взгляд нудные соглашения и стандарты, принимаемые в командах. На конкретных примерах будет показано, что нужно упоминать в соглашениях, а что – нет. Можно ли их заменить различными современными утилитами? Какие выгоды и социальные последствия стоят за процессами принятия и применения? Все это можно будет узнать из данного доклада​

Transcript

1. Практика принятия и применения Coding сonventions в разработке Орлов Юрий Justice1786@gmail.com Telegram: @yobox Facebook: https://www.facebook.com/CyberYuri
2. § Работал в области: - юриспруденция - страхование - логистика и торговля § Занимался решением NP-трудных задач в ФИЦ ИУ РАН. Имею публикации в научных изданиях § Senior .NET Developer в Raiffeisenbank. Занимаюсь full stack разработкой одного из основных проектов банка § Свободное время посвящаю разработке компьютерных игр, изучению .NET Core и методов проектирования ПО Обо мне Практика принятия и применения Coding сonventions в разработке 2
3. 1. В чем, собственно, проблема? 2. Пробуем сходу решить проблему 3. Какова связь соглашений с управлением и взаимодействием в команде? 4. Что же это такое и что должны в себя включать Coding conventions? 5. Нужны ли Coding conventions вашей команде? О чем пойдет речь? Практика принятия и применения Coding сonventions в разработке 3
4. В чем, собственно, проблема? 1
5. Часто ли приходится видеть такой код? Практика принятия и применения Coding сonventions в разработке 5 Boolean b = new Boolean( is_admin ); if( b.toString().length() == 4 ) { // something... } // something
6. А такой? Практика принятия и применения Coding сonventions в разработке 6 Adapter adapter32 = new Adapter (// something... ); Adapter adapter33 = new Adapter (// something... ); Adapter adapter34 = new Adapter (// something... ); Adapter adapter35 = new Adapter (// something... ); Adapter adapter36 = new Adapter (// something... );
7. Или такой? Практика принятия и применения Coding сonventions в разработке 7 Adapter adapter32 = new Adapter (// something... ); Adapter adapter33 = new Adapter (// something... ); //Adapter adapter34 = new Adapter (// something... ); Adapter adapter35 = new Adapter (// something... ); Adapter adapter36 = new Adapter (// something... );
8. Бывает и так… Практика принятия и применения Coding сonventions в разработке 8
9. Примеры поинтересней! Практика принятия и применения Coding сonventions в разработке 9
10. Хвост отваливается… Практика принятия и применения Coding сonventions в разработке 10
11. Хвост отваливается… Практика принятия и применения Coding сonventions в разработке 11 const int X = 1; const int смысл_жизни = 42; private const int ConstantOfVasyaPupkin = 24;
12. • Код выглядит так, будто его писали разные люди, которые не знали друг друга Нет однообразия Практика принятия и применения Coding сonventions в разработке 12
13. Мы строили, строили… Практика принятия и применения Coding сonventions в разработке 13
14. Мы строили, строили… Практика принятия и применения Coding сonventions в разработке 14 • public class StrgMngr{} • public class StorageService{} • public class SM{} • public class Manager1{}
15. • Команда по умолчанию не может «говорить и мыслить» одинаково • Искать что-то в таком коде сложно • В команде появляются «незаменимые люди» Нет единых практик и подходов внутри команды Практика принятия и применения Coding сonventions в разработке 15
16. Умение разбираться в чужом коде… Практика принятия и применения Coding сonventions в разработке 16
17. • Накапливается трудночитаемый код • Код ненаглядный и непонятный • Каждый пишет так, как ему хочется • Хочется стать маньяком и выяснять, где живет коллега Что кроется за такими словами? Практика принятия и применения Coding сonventions в разработке 17
18. Делаю так, потому что могу! Практика принятия и применения Coding сonventions в разработке 18
19. Делаю так, потому что могу! Практика принятия и применения Coding сonventions в разработке 19 if (o is int i || (o is string s && int.TryParse(s, out i)) || (o is double d && (double)(i = (int)d) == d) || (o is MyClass c && (MyClass)(i = (int)MyClass) == c) || …) …;
20. • В коде нужно долго разбираться, чтобы понять его смысл • Можно использовать сложночитаемые конструкции языка В команде каждый сам себе шифровальщик Практика принятия и применения Coding сonventions в разработке 20
21. Пробуем сходу решить проблему 2
22. Простой пример Практика принятия и применения Coding сonventions в разработке 22 - Привет! Я Рома, я люблю форматировать код табами!
23. Простой пример Практика принятия и применения Coding сonventions в разработке 23 - Привет! Я Рома, я люблю форматировать код табами! - Привет! Я Вася, я люблю форматировать код пробелами!
24. Простой пример Практика принятия и применения Coding сonventions в разработке 24 - Привет! Я Рома, я люблю форматировать код табами! - Привет! Я Вася, я люблю форматировать код пробелами! - Привет, я - тимлид Андрей, давайте договоримся и будем все делать одинаково, ваш код вводит меня в депрессию…
25. Принятие Практика принятия и применения Coding сonventions в разработке 25 § Разработка проекта соглашений
26. Принятие Практика принятия и применения Coding сonventions в разработке 26 § Разработка проекта соглашений § Обсуждение
27. Рома привык форматировать табами Практика принятия и применения Coding сonventions в разработке 27
28. Новые правила = ограничения Практика принятия и применения Coding сonventions в разработке 28
29. Принятие Практика принятия и применения Coding сonventions в разработке 29 § Разработка проекта соглашений § Обсуждение § Голосование по спорным вопросам
30. Принятие Практика принятия и применения Coding сonventions в разработке 30 § Разработка проекта соглашений § Обсуждение § Голосование о спорным вопросам (проголосовали 2 против 1) § Вступление в силу
31. И, вроде, все хорошо… Практика принятия и применения Coding сonventions в разработке 31 § Тимлид Андрей переведен на другой проект § Рома снова пишет табами § Вася снова пишет пробелами
32. Результат Практика принятия и применения Coding сonventions в разработке 32 Adapter adapter32 = new Adapter (// something... ); Adapter adapter33 = new Adapter (// something... ); //Adapter adapter34 = new Adapter (// something... ); Adapter adapter35 = new Adapter (// something... ); Adapter adapter36 = new Adapter (// something... );
33. Что пошло не так? Практика принятия и применения Coding сonventions в разработке 33 § Понятие «Принятие» чего либо несколько многозначно: - Принятие как утверждение - Принятие как договоренность между членами команды - Принятие как психологическая реакция со стороны членов команды
34. !Исполнение Практика принятия и применения Coding сonventions в разработке 34 § Соглашения, которые не соблюдаются и не актуализируются - непременно попадают в «долгий ящик»
35. Связь соглашений с управлением и взаимодействием в команде 3
36. Социальное значение соглашений Практика принятия и применения Coding сonventions в разработке 36 § Управление процессами в команде (закон и принуждение) § Культура команды (закон и обычай) § Нравственность членов команды (закон и нравственность)
37. Источники Практика принятия и применения Coding сonventions в разработке 37 § Принуждение § Обычай § Нравственность
38. Источники Практика принятия и применения Coding сonventions в разработке 38 § Принуждение - Руководитель § Обычай § Нравственность
39. Источники Практика принятия и применения Coding сonventions в разработке 39 § Принуждение - Руководитель § Обычай – Команда § Нравственность
40. Источники Практика принятия и применения Coding сonventions в разработке 40 § Принуждение - Руководитель § Обычай – Команда § Нравственность - Вы сами
41. Что демонстрируют в вас Практика принятия и применения Coding сonventions в разработке 41 § Принуждение (вести себя так, как скажут) § Обычай (вести себя так, чтобы другие не имели претензий к тебе) § Нравственность (вести себя так, как ты хотел, чтобы вели себя другие)
42. Что демонстрируют в вас Практика принятия и применения Coding сonventions в разработке 42 § Принуждение (вести себя так, как скажут) § Исполнительность § Обычай (вести себя так, чтобы другие не имели претензий к тебе) § Нравственность (вести себя так, как ты хотел, чтобы вели себя другие)
43. Что демонстрируют в вас Практика принятия и применения Coding сonventions в разработке 43 § Принуждение (вести себя так, как скажут) § Исполнительность § Обычай (вести себя так, чтобы другие не имели претензий к тебе) § Высокий уровень культуры § Нравственность (вести себя так, как ты хотел, чтобы вели себя другие)
44. Что демонстрируют в вас Практика принятия и применения Coding сonventions в разработке 44 § Принуждение (вести себя так, как скажут) § Исполнительность § Обычай (вести себя так, чтобы другие не имели претензий к тебе) § Высокий уровень культуры § Нравственность (вести себя так, как ты хотел, чтобы вели себя другие) § Высокие моральные качества
45. Что важно для исполнения соглашений Практика принятия и применения Coding сonventions в разработке 45 § Наличие аппарата принуждения § Достаточный культурный уровень команды § Соблюдение принципа «не навреди» каждым членом команды
46. Зачем ты нам все это рассказываешь? Практика принятия и применения Coding сonventions в разработке 46
47. Пример Практика принятия и применения Coding сonventions в разработке 47 Дано: Олег – первоклассный разработчик, ищет себе новую команду
48. Пример Практика принятия и применения Coding сonventions в разработке 48 Олег: § Любит работать в крупных компаниях
49. Пример Практика принятия и применения Coding сonventions в разработке 49 Олег: § Любит работать в крупных компаниях § Любит хорошо организованные команды
50. Пример Практика принятия и применения Coding сonventions в разработке 50 Олег: § Любит работать в крупных компаниях § Любит хорошо организованные команды § Не любит код с «плохим запахом»
51. Пример Практика принятия и применения Coding сonventions в разработке 51 Олег: § Любит работать в крупных компаниях § Любит хорошо организованные команды § Не любит код с «плохим запахом» § Уважает своих коллег
52. Пример Практика принятия и применения Coding сonventions в разработке 52 Олег: § Любит работать в крупных компаниях § Любит хорошо организованные команды § Не любит код с «плохим запахом» § Уважает своих коллег § Параноик. Считает, что в его команде есть маньяк, который может узнать, где Олег живет.
53. Пример Практика принятия и применения Coding сonventions в разработке 53 Олег – высоконравственный человек, который ищет себе команду с высокой внутренней культурой
54. Есть ли среди вас такой Олег? Практика принятия и применения Coding сonventions в разработке 54
55. Понравится ли вам в команде, где пишут код вот так? Практика принятия и применения Coding сonventions в разработке 55 Adapter adapter32 = new Adapter (// something... ); Adapter adapter33 = new Adapter (// something... ); //Adapter adapter34 = new Adapter (// something... ); Adapter adapter35 = new Adapter (// something... ); Adapter adapter36 = new Adapter (// something... );
56. Что же это такое и что должны в себя включать Coding conventions? 4
57. Coding conventions are a set of guidelines for a specific programming language that recommend programming style, practices, and methods for each aspect of a program written in that language. Coding conventions Практика принятия и применения Coding сonventions в разработке 57
58. § Стив Макконнелл. «Совершенный код: практическое руководство по разработке программного обеспечения» § Роберт Мартин. «Чистый код. Создание, анализ и рефакторинг» Источники и примеры Практика принятия и применения Coding сonventions в разработке 58
59. § https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/ § https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/inside- a-program/coding-conventions § https://tics.tiobe.com/viewerCS/index.php?CSTD=General (Philips) Источники и примеры Практика принятия и применения Coding сonventions в разработке 59
60. § GitHub (например, https://github.com/ktaranov/naming- convention/blob/master/C%23%20Coding%20Standards%20and%20Namin g%20Conventions.md) § Тематические сайты § Блоги, частные страницы Источники и примеры Практика принятия и применения Coding сonventions в разработке 60
61. Часто встречаемые правила Практика принятия и применения Coding сonventions в разработке 61 § Правила именования § Правила форматирования § Правила комментирования § Правила написания некоторых выражений и блоков § Правила, регулирующие структуру кода § Правила, нацеленные на платформу § Правила оформления и написания тестов § Структура Solution § Иное…
62. Все ли из этого пригодится? Практика принятия и применения Coding сonventions в разработке 62 § В первую очередь правила должны охватывать наиболее важные для команды процессы и конструкции
63. Правила именования Практика принятия и применения Coding сonventions в разработке 63 § Именование сборок и неймспэйсов: Пример: [Имя компании].[Название продукта].[Домен]
64. Правила именования Практика принятия и применения Coding сonventions в разработке 64 § Именование файлов и классов: - совпадение имен классов и файлов -------------A.cs-------------- class B{} - можно ли создавать несколько классов в файле, в каких случаях -------------A.cs-------------- class A{} class B{}
65. Правила именования Практика принятия и применения Coding сonventions в разработке 65 § Именования иных частей: - допустимы ли сокращения и аббревиатуры (FMngr или FileManager) - какой case использовать в различных случаях private readonly Manager; private readonly _manager; - можно ли иметь в классе 2 и более методов с одинаковым названием private void Start(); private void Start(int x);
66. Правила форматирования Практика принятия и применения Coding сonventions в разработке 66 § Основные правила: - максимальная длина строк - в каких случаях делаются пропуски строк - используется табуляция или пробел, сколько пробелов - разрешается ли переформатирование файла, код которого написан в старом формате - иное…
67. Правила комментирования Практика принятия и применения Coding сonventions в разработке 67 § Довольно холиварное § Желательно указать: - нужны ли вообще - на каком языке писать и в каких случаях - какого типа и в каких случаях (однострочные, многострочные, документирующие) - что вообще нужно и можно комментировать (TODO, неиспользуемый код)
68. Правила написания некоторых выражений и блоков Практика принятия и применения Coding сonventions в разработке 68 Например, допустимо ли использовать старые форматы свойств: ... public Order MainOrder { get { return _mainOrder; } set {_mainOrder = value; } } ... В каком стиле допускается писать LINQ-выражения
69. Правила, регулирующие структуру кода Практика принятия и применения Coding сonventions в разработке 69 § В каких случаях допустимы те или иные модификаторы доступа § Что и когда должно быть readonly § Что делать, когда у метода 100500 параметров § Допустимость возвращения null из методов и проверка на null аргументов § Можно ли использовать регионы
70. Правила оформления и написания тестов Практика принятия и применения Coding сonventions в разработке 70 § Структура метода теста (Arrange-Act-Assert) § Правила наименования методов теста § В каких случаях, что тестируем
71. Структура Solution Практика принятия и применения Coding сonventions в разработке 71 § Правила разбиения проектов по папкам § Правила выстраивания связей между сборками § Иное…
72. § Можно ли все соглашения и стандарты автоматизировать? § Можно ли жить без договоренностей и нудных формальных правил? Соглашения? Не слышал! Практика принятия и применения Coding сonventions в разработке 72
73. § Шаблоны ReSharper § NDepend § Статические анализаторы § SonarQube А как же автоматизация? Практика принятия и применения Coding сonventions в разработке 73
74. ReSharper – Formatting Style Практика принятия и применения Coding сonventions в разработке 74
75. ReSharper – Naming Rules Практика принятия и применения Coding сonventions в разработке 75
76. § Хорошо помогает управлять зависимостями в проектах NDepend Практика принятия и применения Coding сonventions в разработке 76
77. § Позволяет искать дублирование кода § Отслеживает покрытие тестами § Отслеживает настраиваемые шаблоны кода § Сложность кода § Накапливание технического долга § Помогает искать уязвимости § И многое другое… SonarQube Практика принятия и применения Coding сonventions в разработке 77
78. Что еще стоит учесть? Практика принятия и применения Coding сonventions в разработке 78
79. Нет ничего более постоянного, чем временное Практика принятия и применения Coding сonventions в разработке 79
80. Соглашения нужно актуализировать Практика принятия и применения Coding сonventions в разработке 80
81. Нужны ли Coding conventions вашей команде? 5
82. В чем польза соглашений? Практика принятия и применения Coding сonventions в разработке 82 § Помогают быстрее погружать в проект нового сотрудника и помогают ему быстрее найти общий язык с командой § Подталкивают писать хорошо читаемый код, помогают избавиться от эзотерики § Формируют единые практики и правила поведения для всех членов команды § Разработчики становятся взаимозаменяемыми
83. В чем польза соглашений? Практика принятия и применения Coding сonventions в разработке 83 § Помогают быстрее погружать в проект нового сотрудника и помогают ему быстрее найти общий язык с командой § Подталкивают писать хорошо читаемый код, помогают избавиться от эзотерики § Формируют единые практики и правила поведения для всех членов команды § Разработчики становятся взаимозаменяемыми § Дают возможность HR-ам не писать в требованиях: «умение разбираться в чужом коде»
84. Пример из личного опыта Практика принятия и применения Coding сonventions в разработке 84 § У команды есть принятые соглашения § У команды есть соглашения в виде устных договоренностей и шаблона ReSharper § У команды нет договоренностей ни в каком виде
85. Есть принятые соглашения Практика принятия и применения Coding сonventions в разработке 85 § Хорошо организован процесс погружения для нового сотрудника § Хорошо организован процесс CR (тратилось меньше времени) § Довольно редко возникали холивары (кроме случаев, когда соглашения нуждались в пересмотре)
86. Есть устные договоренности и шаблон ReSharper Практика принятия и применения Coding сonventions в разработке 86 § При погружении нового сотрудника в проект особых проблем нет, но у последнего возникает множество вопросов § Хорошо организован процесс CR, но возникают случаи, когда каждый остается при своем мнении § Холивары возникали редко, но они были
87. Есть устные договоренности и шаблон ReSharper Практика принятия и применения Coding сonventions в разработке 87 После принятия соглашений мнения членов команды разделились: § Ничего не поменялось § Стало только хуже: во время CR стали чаще апеллировать соглашениями § Стало удобнее: правила стали прозрачнее, их стало удобнее пересматривать и автоматизировать
88. Нет договоренностей Практика принятия и применения Coding сonventions в разработке 88 § Процесс погружения нового сотрудника значительно усложнен: не понятно, как принято работать в проекте, сложно читать код § Процесс CR больше напоминает формальность, каждый начинает апеллировать на свои личные познания § Холивары – частое явление
89. Выводы Практика принятия и применения Coding сonventions в разработке 89 § Coding conventions дают определенные преимущества команде § Принятие соглашений процесс сложный § В основе исполнения соглашений лежат принуждение, культура команды и нравственность каждого члена команды § Coding conventions – прежде всего соглашения в команде, а не попросту стандарты, навязываемые сверху § Правилами нужно охватывать наиболее важные для команды процессы и конструкции § Некоторые соглашения можно автоматизировать § Соглашения нужно постоянно поддерживать и актуализировать
90. Спасибо за внимание! Орлов Юрий Justice1786@gmail.com Telegram: @yobox Facebook: https://www.facebook.com/CyberYuri