@mkone112
Начинающий питонист.

Как делать комментарии в коде только для себя?

Как можно писать комментарии в коде так чтобы они не попадали в репозиторий? Пример ситуации: я джун/стажер, прихожу на свой первый проект, получаю некую задачу, стягиваю себе репозиторий и пытаюсь как-то в нем разобраться и, разумеется, пишу комментарии, поясняющие работу тех или иных кусков кода. Затем выполняю поставленную задачу и делаю push обратно в репозиторий. Как сделать так чтобы мои «заметки по коду» не попали в master?
  • Вопрос задан
  • 179 просмотров
Решения вопроса 1
delphinpro
@delphinpro
frontend developer
Хочу — индексирую целые блоки, а хочу — только выделенные строки. Atlassin SourceTree.

5f704cd7c4a98090079782.png

Детали в комментариях выше :)
Ответ написан
Пригласить эксперта
Ответы на вопрос 3
Есть такая штука, блокнот называется, вот в ней и делаете для себя пометки
Ответ написан
Aetae
@Aetae
Тлен
Если впоследствии тебе самому эти комменты не нужны, то просто заводишь свой git hook (написанный тобой же на удобном тебе языке), который перед отправкой будет затирать в файлах твои особые комменты(напр по какой-то метке).
Если нужны, то вроде были плагины для разных ide позволяющие писать комменты к файлу(не в коде), погугли для своей.
Удалять комменты перед отправкой и вставлять обратно в код - не вариант, знатный геморрой возникнет с мержами и разрешением конфликтов.

P.S. Вообще просто пиши комменты аккуратно и заливай их вместе с кодом. Документирующие комменты вовсе не лишние.)
Ответ написан
@xdvz
Для IDE от Jetbrains есть, например, вот такой плагин:
https://plugins.jetbrains.com/plugin/13028-code-notes
Ответ написан
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы