Как избежать ошибок и сделать свой код достойным

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

  1. ДОКУМЕНТАЦИЯ

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

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

Документация не должна выглядеть суперпрофессионально, но простого текстового документа, описывающего, что делает фрагмент кода, что такое ввод и что такое вывод, будет достаточно.

2. КОММЕНТАРИЙ /**

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

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

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

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

Легко потерять счет времени и даже упустить из виду конкретные, осязаемые шаги, которые вы пытаетесь предпринять. Метод Master Data Science включает планирование этапов в форме контрактов на строительство. Прежде чем приступить к реализации, вам нужно ответить на несколько вопросов, а мне нравятся полезные коучинговые вопросы.

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

Просто решите, какой у вас стиль, и если он не для вас, настройте его точно так же, как для любого другого проекта.

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

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

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

3. ОТЛАДКА!

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

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

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

4. ГИТХАБ

Поддержание вашего кода на GitHub поможет вам уверенно вносить изменения, не боясь что-либо сломать. Это помогает вам отслеживать, что вы изменили, и делает вас счастливым и уютным, и оно не удаляется, когда кто-то покидает магазин.

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

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