IT Developer 28.01.2025

Ссылка на код

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

Ссылка на GitHub/GitLab

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

Репозиторий может быть как закрытым так и открытым.

Пример вопроса с ссылкой на код

В айдите произошли правки к переводу. Пожалйста, посмтрите, все ли верно?. Ссылка на коммит.

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

Ссылка на GitHub и GitLab можно открывать как на ПК так и на телефоне — поэтому этот способ будет удобным независимо от используемого устройства.

Если код потребует правок, их можно тут же внести. Напомню, что на данный момент и GitHub и GitLab предлагают доступ к репозиторию через встроенный в них редактор VSCode.

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

Как быстро получить ссылку на репозиторий из IDE?

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

Поэтому вас следует настроить горяую клавишу на быстрое копирование ссылки в вашей IDE.

Пример настройки для phpStorm для GitLab.

Откройте настройки: File | Settings | Keymap

Найдите и задайте hotkey, рекомендую alt + 4, на следующие дейсвтия:

Main Menu | Edit | Cut/Copy/Paste Actions | Copy Path/Reference… | Copy Link to GitLab Repository;
Plugins | GitLab | Copy Link to GitLab Repository.

Ссылка на файл

В нужном файле нажмите выбранное сочетание клавиши — ссылка на код в GitLab — будет скопирована в буфер обмена.

Ссылка на нужную строку или диапазон строк в файле

Если бы выделите несколько строк — выбранные строки так же будут добавлены в ссылку.

Ссылка на коммит

В истории коммитов вы также можете выделить нужный коммит и нажать выбранное сочетание клавиши — чтобы скопровать ссылку на коммит.

Для другие IDE и для GitHub настройка производится аналогично.

Ссылка на GitHub/GitLab

Как делать не надо

Не делайте сркины кода.

Популярное решение — но не идеально.

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

Не давайте цитаты самого кода.

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

Пример плохого вопроса с цитатой кода:

Почему у меня в результате не те данные?

$url = 'https://cse.google.com/cse/element/v1';
$url .= '?' . http_build_query($queryData);

Почему еще так делать не стоит:

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