Как мне исправить код от менее опытного программиста?

19

Немного предыстории: я один из двух программистов для нашего отдела из 10 человек (остальные художники и менеджмент). Мы вдвоем делаем все необходимое для правильного кодирования и разрабатываем любые проекты, которые появятся. Я занимаюсь программированием около 4 лет, где это его первая «настоящая» работа (как он выразился). Обычно мы работаем над разными проектами в любой момент времени.

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

Началась следующая часть этого проекта, над которой я работаю. Я открыл интерфейс, чтобы начать со следующих шагов, и сразу столкнулся с проблемами (немного медленным было небольшое занижение, ошибки в общих действиях и т. Д.). Я посмотрел на код для нескольких проблем и нашел, O(n^n)какие вызовы должны быть O(n), предположения типа без проверки ошибок (это на Python), ссылки на GUI, добавленные в исходный код, и так далее.

Теперь я определенно хотел бы научить его, что было не так и как это исправить, но он уже перешел к своему следующему проекту, и это было несколько недель назад. Боюсь, что я говорю "Вернись и сделай это правильно!" (конечно, с помощью) слишком суров, и у нас все еще есть другие проекты, которые можно реализовать за это время. Должен ли я сам сейчас исправить код и попытаться поймать вещи в будущем?

TorelTwiddler
источник
4
В будущем, есть ли возможность согласовать руководящие принципы кодирования, которые предотвратят ошибки, подобные описанным вами?
Бенни
5
Хорошо, что вы не сразу бежите к руководству и не рассказываете о нем. Некоторые компании ориентированы на вину. Когда вы отметите исправления, найдите способ сгруппировать их, а затем попросите этого парня взглянуть на них позже. С другой стороны, даже новый выпускник не должен кодировать что-либо, O(n^n)если только нет другого пути. Если они это сделают, то они, вероятно, получили C в алгоритмах или не взяли его, или имели дерьмового учителя. Было бы неплохо использовать какой-то инструмент для поиска общих проблем. Возможно, в качестве следующего задания этот парень может написать несколько тестов производительности?
Работа
O (n ^ n) без документации о том, почему это просто неправильно, точка. Если вы действительно должны это сделать, комментарии лучше объясните почему.
Лорен Печтел
Собирался написать, что «эй, O (n * n) не так уж и плохо, многим приложениям это нужно ...», но потом я понял, что это был не знак умножения, а убийца ^!
Макс
O (n ^ n) может быть на порядок быстрее, чем O (n), если O (n) имеет огромную постоянную, а n мало. codinghorror.com/blog/2007/09/… Опять же, n ^ n - это крайность: D
Кодер

Ответы:

33

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

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

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

nithins
источник
3
+1 Проверка кода - отличный способ сделать это. Я бы посоветовал сформулировать это так: «Не могли бы вы взглянуть на изменения, которые я сделал, чтобы убедиться, что я ничего не пропустил», а не «Вот способы, которыми я улучшил ваш код».
Стив Джексон
1
+1 Я бы сказал, что обзор кода гораздо лучше, чем любые «правила кодирования золотого правила». Не много вещей никогда не бывает в порядке.
Макс
Мне очень нравится эта идея, спасибо. Теперь мне просто нужно немного изучить хорошие способы сделать обзоры кода!
TorelTwiddler
1
На самом деле есть хорошая и интересная статья с некоторыми основами, доступными по адресу mumak.net/stuff/your-code-sucks.html . В основном речь идет о поведенческих методах конструктивного проведения проверок, что чрезвычайно важно для успешных проверок.
нифины
@TorelTwiddler, просто помните, что обзоры кода предназначены для обучения, а не обвинения. Укажите вещи, которые он сделал хорошо, поэтому он знает, что они хороши в то же время, предлагая пути улучшения.
CaffGeek
5

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

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

Николас Смит
источник
2

Можем ли мы сделать вывод, что проект «работает» и был выполнен за разумное количество времени (хотя и с некоторыми вопиющими, но исправимыми проблемами проектирования)? Если так, то он в гораздо лучшей форме, чем многие проекты, которые я видел за эти годы.

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

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

Люди хорошо учатся, когда видят, как выглядят действительно хорошие вещи. Это лучше, чем систематически указывать на каждый маленький недостаток. O (n ^ n), однако, следует аккуратно и конструктивно указать.

Angelo
источник
0

Поделитесь своими знаниями.

Я предложил бы ему помощь в его новом проекте в обмен на некоторое обучение от старшего до младшего.

Почему не парное программирование в обоих проектах?

mouviciel
источник