Рецензенты кода (Серия из 3 частей)
Когда дело доходит до написания комментариев к обзору кода, убедитесь, что вы вежливы, добры и поощряете разработчиков.
Уважение:
1) Будьте добры и полезны разработчику, чей код вы просматриваете. 2) Убедитесь, что вы всегда комментируете код, а не разработчика.
Объяснение:
1) Всегда обязательно объясняйте, почему вы делаете комментарий 2) Попробуйте привести “хороший/действительный” пример, чтобы он помог разработчику понять. Всегда необходимо приводить примеры.
Руководство:
1) Не предоставляйте решение или не пишите код для разработчика, а предоставляйте полезную информацию, чтобы разработчик нес ответственность за исправление списка изменений. 2) Поддерживайте баланс между указанием на проблемы и предоставлением рекомендаций.
Спасибо:
Спасибо всем за чтение этой серии. Надеюсь, вы попытаетесь реализовать это в режиме реального времени и станете лучшим специалистом по анализу кода. Если вам понравился мой пост, пожалуйста, оставьте отзыв ниже, я постараюсь изменить, если в моих будущих постах будут какие-либо ошибки.
Изображение баннера Любезно предоставлено: Бизнес-вектор, созданный freepik – www.freepik.com
Рецензенты кода (Серия из 3 частей)
Оригинал: “https://dev.to/divakarkumar/how-to-become-a-better-code-reviewer-part-3-how-to-write-code-review-comments-80b”