Примеры кодирования в этой статье написаны на p5.js. Но вы все равно можете следить за ним, независимо от того, на каком языке вы говорите. 😀
Такое случается со всеми нами.
Вы пишете код, и все идет хорошо.
Затем вы наталкиваетесь на стену в своей логике и начинаете чувствовать себя застрявшим.
Возможно, у вас есть сеть других программистов, которые могут помочь вам с вашей проблемой. Или, возможно, вы обращаетесь к кому-то новому.
В команде TA по программе Make School’s RAMP мы помогаем многим новичкам.
Если вы пытаетесь распутать запутанное выражение «если» или пытаетесь получить основы использования объектов и классов, эта статья поможет вам научиться обращаться за помощью к другим программистам.
Три шага к получению эффективной обратной связи
- Комментарий: размещайте четкие, подробные комментарии в очевидных местах вашего кода (или сопровождайте свой код ясным сообщением при его отправке).
- Объясните: Сообщите другому инженеру, что вы уже понимаете о проблеме (давай, я знаю, что вы понимаете кое-что в этом вопросе).
- Попробуйте. Сообщите своему коллеге-программисту, что вы уже пробовали для решения проблемы (обязательно попробуйте, прежде чем обращаться за помощью).
Как думать о проблемах с кодированием
Часто, когда вы общаетесь с кем-то, кто позже прочитает ваш код, будь то другой программист или вы в будущем, вы будете использовать комментарии, чтобы оставлять сообщения внутри вашего кода.
Каждый язык обозначает комментарии по-разному.
В однострочных комментариях Javascript и p5.js…
// ...look like this. Two forward slashes start the comment...
… И заблокировать комментарии (более одной строки)…
/* ...look more like this with a forward slash, then an asterisk to start the block. And an asterisk, then a forward slash to end the block. Remember to close the block properly or there might be issues later. */
Если вы не используете Javascript, вы можете узнать, как пишутся комментарии на предпочитаемом вами языке программирования.
Комментарии - это супер фантастика, потому что это свободное пространство, где вы можете писать все, что хотите. Внутри комментария обычные правила синтаксиса кодирования не применяются.
Итак, как я могу использовать комментарий, чтобы эффективно рассказать о своих проблемах с кодированием?
Давайте рассмотрим это на примере.
В приведенном выше фрагменте у нас есть код p5.js с объектами и классами. Мы видим, что в строке 17 программист использовал комментарий, чтобы попросить о помощи.
Но довольно сложно понять, что они уже знают о своем коде. И даже несмотря на то, что проблему с этим кодом довольно легко обнаружить, все же может быть трудно понять, где их логика разваливается и почему им может понадобиться помощь здесь.
Именно здесь на помощь приходят части нашего сообщения объяснять и попробовать. Мы должны убедиться, что в наших комментариях содержится подробная информация о:
- Что пытается решить наш код
- Где мы застряли и (если можете), в чем, по вашему мнению, может быть проблема
- Что мы уже пытались решить
ПРИМЕЧАНИЕ. Да, это означает, что даже если у вас очень мало идей, с чего начать, вы всегда должны попробовать самостоятельно, прежде чем просить кого-то о помощи.
Объяснение делает пару хороших вещей для человека, который вам помогает.
- Это показывает им, что вы посвятили себя решению проблемы.
- Это не позволяет им тратить время на объяснение уже знакомых вам концепций.
- Это может помешать им предлагать решения, которые вы уже исключили.
- Это может помочь им показать вам различные способы осмысления проблемы, которые могут помочь вам найти решение для себя.
И еще одна удивительная вещь, которую можно сделать с помощью такого комментария:
Это может помочь вам отладить собственные ошибки еще до того, как вы обратитесь к другому человеку!
В информатике существует такое понятие, как отладка резиновой уточки. Иногда, просто объяснив, что происходит в вашем коде в подробном виде резиновой утке, другому человеку или, в данном случае, записав это, в вашей голове загорается лампочка, и вы находите решение!
Если вы практикуете хорошее написание комментариев, вы сможете увидеть решение для себя еще до того, как нажмете кнопку отправки.
Теперь, когда мы знаем, как объяснить проблемы в нашем коде и попытались их исправить, давайте посмотрим, как можно улучшить наш приведенный выше фрагмент.
Итак, давайте предположим, что наш программист еще не понял момента, когда они загорелись, и проанализирует их изменения.
- Они переместили свой комментарий в начало файла, чтобы нам не приходилось его искать. Если у вас есть большой длинный файл с большим количеством вложенного кода, это может сэкономить время.
- Они используют заблокированный комментарий, поскольку им нужно сказать более одной строчки.
- Они четко объяснили проблему, даже если не уверены в проблеме, и пытались решить проблему, ища ответы на справочной странице p5.js.
Возможно, вы уже заметили их опечатку в строке 13, но теперь мы также знаем, что у них возникли проблемы с использованием справочного сайта p5.js, который является их основным инструментом документации.
Когда я даю им обратную связь, чтобы помочь им найти опечатку, я также могу дать им советы по использованию документации p5.js.
Теперь у них будет не только код, который производит ожидаемый результат (ура! 🎉), но они также будут лучше подготовлены для решения более сложных проблем в будущем, зная больше о документация.
Помогла ли эта статья вам начать использовать более качественные комментарии, чтобы задавать вопросы в коде?
Не стесняйтесь отвечать на эту статью ниже и дайте мне знать, если да!
Если вы хотите научиться программировать, вы можете прочитать статью на Medium о программе Make School RAMP здесь.
Чтобы узнать больше о том, как получить доступ к RAMP и процессу приема в школу в целом, отправьте электронное письмо на адрес [email protected].
