Как писать чистый понятный код

Актуальность темы обоснована тем, что конструирование, написания кода является одной из наибольших процессов разработки программных продуктов. Однако, написание не является единственным процессом работы с кодом. В дальнейшем любой код подвергается модификации, улучшениям, тестированию и устранению ошибок. Для этого необходимо писать код доступный для понимания, легко читаемый, понятный не только для автоматизированных устройств, но и для разработчиков программ, для людей. Такой код ускоряет процесс работы как с ним, так и над ним. Он может обеспечить ускоренное прохождение различных тестов, понятность возникновения ошибок, легкость во внедрении новых функций.

Именно таким является чистый код – код, который легко читать, редактировать и понимать функциональность. Такой код не обязательно должен быть написан изначально. Не каждый код, не соответствующий принципам чистого кода должен быть удален и переписан заново. К нему можно прийти, его можно модифицировать и привести к чистому путем рефакторинга, что тоже входит в понятие написания чистого и понятного кода.

Целью реферата является изучение понятия, принципов написания и чистого и понятного кода, а также возможностей приведения к нему.

Задачами реферата являются:

– изучить определение чистого кода;

– рассмотреть принципы написания чистого кода на примере особенностей написания некоторых элементов программы;

– изучить возможности приведения к чистому коду посредством рефакторинга;

– рассмотреть определение и принципы рефакторинга.

Объектом исследования является процесс написания программы, написанной чистым и понятным кодом.

Предметом исследования является принципы и основные требования к написанию чистого и понятного кода.


РАЗДЕЛ 1. ОПРЕДЕЛЕНИЕ И ПРИНЦИПЫ ПОСТРОЕНИЯ ЧИСТОГО КОДА

1.1. Определение чистого кода

Основным источником для определения понятия «чистый код» является книга Роберта К. Мартина «Чистый код. Создание, анализ и рефакторинг». В данной книге определение дается скорее концепции, выведенной через «мнение опытных программистов», таких как сам Роберт Мартин, Бьёрн Страуструп, Грэди Буч, Дэйв Томас и т.д. и описывается как программный код, обладающий следующей серией качеств [1]:

1. Элегантность – в контексте данной темы рассматривается код, простой, при этом изобретательный, «доставляющий удовольствие» при чтении и корректировке.

2. Эффективность – подразумевается, как экономия времени работы процессора при компиляции и работе программы.

3. Четкость – содержание только необходимых элементов кода, неся в себе краткий, фактических смысл всей работы в целом и каждой части, при этом ориентируясь на принцип «чем меньше, тем лучше».

4. Грамотность – четкое построение соответствующих выбранному языку конструкций в некоторых случаях с привлечением понятия «грамотного программирования» как понятия кода, написанного для чтения и понимания не только техникой, но и людьми.

5. Тщательность – рассматривается как затраты времени и ресурсов на написание проработанного кода, не подразумевающего больше никаких усовершенствований.

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

7. Реализация программы соответствует всем критериям технического задания и выполняет все требуемые операции, при этом не создавая «запутанной логики».

Исходя из всех перечисленных качеств можно сделать более общее определение чистого кода – кода, который понятен людям при чтении, модификации, поиска и устранении ошибок. Код, который экономит время работы не только человека с ним, но и компьютера для его обработки, тестирования и выполнения программы. Таким образом чистый под поддерживает парадигму построения архитектуры информационных систем, заключающейся сокращении человеческих затрат и усилий при создании и сопровождении системы.

1.2. Имена в чистом коде