Чистый код в Android
Прежде чем вы начнете работать над собственным кодом, надо сначала понять, как вы будете его масштабировать и им управлять. В этой статье мы поговорим о том, что такое чистый код и как повысить качество своей работы, начав программировать лучше.
Давайте представим себе огромную библиотеку с книгами. Когда книги классифицированы и отсортированы, найти нужное издание не составит труда и займет мало времени. Не говоря уже о том, что красивый дизайн интерьера позволит читателю чувствовать себя комфортно.
Совсем по-другому обстоят дела, когда все книги свалены в общую кучу или расставлены абы как.
Ситуацию можно спроецировать и на программирование. Если речь идет о создании чего-то действительно стоящего, стоит позаботиться не только о написании кода, но и о том, чтобы код был аккуратно организован. В результате любой читатель (например, ваш коллега программист), придя в вашу «библиотеку», увидит в ней аккуратное расположение имен переменных, пакетов и классов, что позволит ему быстро все понять.
Так что же такое «чистый код»?
Код называют «чистым», если в нем без проблем разбирается вся команда. В результате любой разработчик способен не только прочитать его, но и улучшить. Если код понятен, он читаем, изменяем, расширяем и легок в сопровождении.
Другая сторона медали — наспех законченный проект и код, который не может полностью понять никто, кроме вас. И Бога, как на картинке выше))) Это не что иное, как ваша недоработка. Такой код «чистым», разумеется, не будет.
Качества чистого кода
Заботиться о «чистоте» кода нужно всегда, думая о том, как сделать его более читабельным и простым.
Основные характеристики чистого кода:
• элегантность: готовый код радует вашу сущность, как радует любителя прекрасного красиво сделанная музыкальная шкатулка или другое произведение искусства; • простота: код не изобилует сложными конструкциями, он прост и упорядочен, количество объектов минимально, отдельное внимание уделено деталям; • сфокусированность: любая функция, класс и модуль выполняют одну определенную задачу, лишние фичи и дубликаты отсутствуют; • универсальность, эффективность, тестопригодность. Код успешно работает на всех тестах.
И никогда не забывайте о том, что писать код, понятный другим, -- это один из главных признаков профессионала.
Задавайте уместные имена
Да, на выбор хорошего имени вы потратите дополнительное время, однако по итогу вы сэкономите намного больше. Функция, класс, переменная — имена должны отвечать на самые главные вопросы: зачем, что делает, как применяется. Скажем так, имя хорошее, если его не надо комментировать.
Пример:
Имена классов
Объекты и классы принято называть существительными либо фразами из них: Customer, WikiPage, Account, AddressParser. А вот следующих слов в названиях класса лучше избегать: Manager, Processor, Data, Info. Кроме того, имя класса не должно быть глаголом.
Имена методов
Методы нужно называть глаголами либо фразами из них:
Применяйте доменные названия для задач
Если возникла проблема с подбором названия, используйте доменные названия для задач. При возникновении затруднений с пониманием, разработчик, поддерживающий ваш код, просто спросит эксперта по домену, что означает это название.
Что же, в следующий раз поговорим о том, как писать код с использованием принципов S.O.L.I.D. А пока можете отдохнуть))
По материалам статьи «Understanding Clean Code in Android».
