Я начну с известной цитаты:
«Любой дурак может написать код, понятный компьютеру. Хорошие программисты пишут код, понятный людям ». - Мартин Фаулер
Если честно, что бы я ни сказал, я не могу этого достаточно подчеркнуть. Сейчас явно недостаточно написать рабочий код. Качество кода играет жизненно важную роль в выделении вашего проекта среди остальных. Следование передовым отраслевым практикам и поддержание стандарта в коде может помочь вам и вашим товарищам по команде, как нынешним, так и будущим, при совместной работе. Давайте углубимся в некоторые стандарты кодирования, о которых вам следует подумать, когда вы будете писать код. Кроме того, эти неформальные правила не зависят от используемого вами языка. Поэтому я не использовал примеры из исходного кода, которые могут помешать некоторым читателям извлечь максимальную пользу из этой статьи.
- Меньше и простой код.
Золотое правило здесь - «Думай больше и меньше кодируй». Когда вы пишете код, вы обязательно встретите случаи, когда вы можете упростить свои фрагменты кода, чтобы сделать его более чистым и простым. Вот несколько способов добиться этого:
- Рефакторинг - эта функция предоставляется многими текстовыми редакторами, включая Visual Studio Code, IntelliJ, Eclipse и т. Д. Это полезно, особенно когда вы хотите реструктурировать свой код в более удобочитаемом виде, не мешая выводам. Рефакторинг также может упростить исправление ошибок.
2. Использование ООП / базовых концепций, когда это возможно. Это упрощает сопровождение кода, упрощает добавление любых будущих изменений, не отнимая много времени, и устраняет повторяющиеся фрагменты кода. Поясним это на примере:
Например: если вы используете концепцию наследования, это позволяет повторно использовать фрагменты кода и, таким образом, предотвращает избыточность кода. Это возможно, потому что все повторяющиеся элементы данных и функции могут быть включены в родительский класс. Поскольку они наследуются в дочерние классы, нам не нужно повторять их снова.
Вы можете использовать концепцию абстракции в ООП, чтобы упростить приложение, скрывая ненужные детали от конечного пользователя.
3. Использование шаблонов проектирования. Использование шаблонов проектирования упрощает общение между разработчиками программного обеспечения. Кроме того, эти шаблоны проектирования делают систему менее хаотичной и упрощают ее обслуживание. Шаблоны дизайна можно использовать повторно, и они добавляют прозрачности дизайну приложения.
4. СМЕРТЬ: Дублирование - это зло. Дублированные строки кода могут сделать ваш проект ненужным, длинным и громоздким, а также затруднить просмотр кода. Рекомендуется по возможности избегать дублирования кода и определять функции, если операции необходимо дублировать.
5. Дайте функциям / классам одну цель - это может уменьшить головную боль, которую вы получаете, когда читаете строки кода некоторых функций, которые содержат тысячи строк кода для выполнения сотен задач. Одна функция выполняет только одно действие, а класс несет единственную ответственность.
2. Удобочитаемость ›Сообразительность
Многие программисты объединяют «чистый код» с «умным кодом». Они склонны думать, что если они смогут втиснуть 10 строк кода в одну, используя какой-нибудь хитрый трюк, это будет чище. Но чаще всего это не так. Сообразительность - это решение головоломок, а не создание большего. Читаемость не менее важна для меньшего количества кода, и вот несколько моментов, которые вы должны помнить при написании кода, чтобы сделать ваш код более читаемым для других сторон.
- Комментирование избавляет от многих головных болей! - Комментарий - это специально выделенный текст, зависящий от языка программирования, который объясняет исходный код. Добавление комментариев делает код более читабельным, а также помогает в исправлении ошибок. Но суть в том, что слишком много комментариев снижает ваш стандарт кодирования. Вы не должны добавлять комментарии к каждой строке исходного кода или к очевидным частям кода. Помните, что комментарии предназначены для разъяснения, а не для кормления с ложечки. В большинстве языков есть три основных типа комментариев: встроенные, многострочные и комментарии в документации.
- Поддержание правильного отступа - наличие необходимых частей кода с отступом является обязательным требованием в некоторых языках программирования, таких как Python. Но всегда полезно использовать отступы, потому что они делают ваш код читабельным, поскольку он визуально представляет циклы и операторы выбора.
- Использование пробелов при необходимости - Вам нравится читать сбитый в кучу код? Что ж, самый распространенный ответ - нет. На самом деле добавление пробелов успокаивает читателя и не требует особых усилий. Это одна из самых недооцененных практик, и она очень эффективна.
3. Используйте соглашения об именах и поддерживайте последовательную схему именования.
Использование значимых и описательных имен при именовании элементов данных и методов - это то, что обычно упускается из виду, но это очень важно. Это действительно полезно, когда кто-то ссылается на ваш код.
4. Желательно по возможности избегать длинных строк кода.
Вы можете использовать стили и отступы в своих интересах, когда имеете дело с длинными строками кода, которые может быть утомительно читать.
5. Избегайте глубокой вложенности.
Вложенные циклы часто (но не всегда) являются плохой практикой, поскольку они могут сделать ваш код менее удобным для чтения и вызвать неожиданные результаты. Точно так же использование слишком большого количества операторов if - плохой запах кода и может потребовать рефакторинга.
6. Сохраняйте структуру папок.
Будь то кодирование или реальная жизнь, организация важна во всем, что мы делаем. Организация делает кодирование и рецензирование более эффективным и приятным.
7. Регулярно просматривайте свой код.
Помните, что ваша работа не выполняется с последней точкой с запятой. Вам нужно часто пересматривать свою работу, чтобы поддерживать ее и улучшать. Вы приобретете много опыта, когда продолжите работу над проектом, поэтому всегда рекомендуется использовать этот опыт для создания начальных кодов в соответствии с этим стандартом.
8. Используйте отраслевые принципы.
Использование принципов проектирования, таких как принцип SOLID, уменьшает зависимости и, таким образом, позволяет изменять части вашего кода позже, не нарушая работу всей системы, делая ее более адаптивной. Так что это очень недооцененная практика кодирования, которую вы можете использовать, чтобы заставить свой код работать наилучшим образом.
9. Использование инструментов обнаружения кода, таких как Checkstyle, ESLint, Findbug.
10. Документируйте все.
Да вы не ослышались! Сделайте ставку на то, чтобы должным образом документировать все, что связано с разработкой вашего программного приложения, от текстов Readme до заметок по проекту и документов с решениями. В конечном итоге это сделает вашу жизнь намного проще.
11. Следите за проблемами безопасности, связанными с разработкой программного обеспечения.
Всегда используйте шифрование, предотвращение потери данных и другие методы защиты информации, если ваша система имеет дело с конфиденциальной информацией от вашего клиента. Всегда помните: «Профилактика лучше лечения».
Пора закатать рукава и написать чистый код. Ваше здоровье!
