Попасть в мир программирования - это грандиозный и уникальный путь для каждого человека. Но как далеко вы зайдете, сколько споткнетесь и сколько времени потребуется, чтобы найти свои сильные и слабые стороны, решать только вам. И позвольте мне сказать вам, что нельзя сдаваться, вы должны продолжать идти вперед, постоянно признавая и извлекая уроки из своих слабостей, а также распознавая шаблоны, которые могут помочь вам в вашем продвижении.

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

1. Сделайте его читабельным

Из простой программы мы создаем сложное приложение, но когда код становится слишком большим, его может быть сложно интерпретировать. Во время отладки кода или при обновлении кода через долгое время может случиться так, что вы потеряетесь в строках, если программа нечеткая.

Читаемость также играет важную роль, когда мы работаем в команде. В среднем разработчик тратит 75% времени на понимание кода, 20% времени на изменение существующего кода и только 5% времени на написание нового кода. Небольшое дополнительное время, потраченное на удобочитаемость, сокращает время понимания для товарищей по команде. Следовательно, важно поддерживать правильный отступ и пробел.

2. Напишите комментарии

Если было трудно писать, сделайте так, чтобы это было легко читать.

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

Пишите содержательные однострочные комментарии для сложных строк; написать описание функциональности для функций и методов; для сложных логических блоков при необходимости опишите логику словами. И не забывайте, всегда обновляйте свои комментарии!

3. Что в имени? - очень много!

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

  • Всегда используйте CamelCasing: getName (), studentName.
  • Напишите названия констант в верхнем регистре с подчеркиванием, разделяющим каждое слово: ARRAY_SIZE.
  • Не делайте имя слишком описательным, старайтесь, чтобы его длина была короткой.
  • Избегайте создания переменных или функций с похожими именами: если вы создадите функцию с именем addInList () и другую функцию с именем appendInList (), у вас могут возникнуть проблемы с пониманием кода позже.
  • Убедитесь, что описание переменной или функции также должно соответствовать их функциональности.

4. Одна функция, одна работа

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

По возможности их следует рассматривать как «черные ящики», потому что нам не нужно знать, как они работают. Только то, что должно войти в них, и что должно выйти из них. Распространенным практическим правилом является «Правило десяти строк» ​​, обычно функция длиннее, чем десять строк, пытается сделать слишком много, и его следует упростить.

5. Избегайте глобального кода

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

В идеальном случае у вас не должно быть блоков, определенных глобально. То есть все операторы switch, try-catch, for, while-loops и т. Д. Должны быть написаны внутри метода или функции.

6. Рефакторинг

Хотите верьте, хотите нет, но вы должны реорганизовывать свой код ежедневно, иначе ваш код не в хорошем состоянии! Вам следует провести рефакторинг всего, от вашей архитектуры до ваших методов и функций, имен переменных, количества аргументов, которые получает метод и т. Д.

Рефакторинг - это скорее искусство, чем наука, но есть несколько правил, которые могут пролить на него некоторый свет:

  • Если ваша функция или метод состоит из более чем 15–20 строк, более вероятно, что вы включаете в них слишком много логики, и вы, вероятно, можете разделить их на две или более более мелкие функции / методы.
  • Если у вас много вложенных циклов, возможно, вы выполняете некоторую ресурсоемкую обработку, не осознавая этого. В общем, вам следует переосмыслить логику, если вы вкладываете более 2 петель. Три вложенных цикла могут немного запутаться!
  • Держите код в актуальном состоянии, включая все последние вещи, которые вы узнали, используйте последний синтаксис, убедитесь, что вы не используете устаревшие методы.
  • Подумайте, есть ли какие-либо подходящие шаблоны проектирования, которым может следовать ваш код. Не следует использовать шаблоны только ради шаблонов, но шаблоны предлагают проверенные и готовые решения, которые могут быть применимы.

7. Производительность (не менее важна, чем глазурь)

Последний аспект хорошего стиля программирования, о котором забывают, - это то, как выводится ваша программа и насколько ясна информация, предоставляемая пользователям. Частью написания профессионально выглядящих программ является предоставление пользователям наших программ четких инструкций и результатов. Вы всегда должны предполагать, что пишете программы, которые будут использоваться кем-то, не разбирающимся в компьютерном программировании. Считайте, что вишенка наверху заключается в использовании правильного белого пространства и выравнивания в вашем выводе.

Подводя итог всему: вы можете найти эти советы и рекомендации базовыми или, возможно, слышали о них много раз, но потеря навыка не даст вам того результата, которым вы будете ожидая! Поэтому всегда старайтесь прививать их как можно тщательнее.