Что я должен включить в заголовок документации моего класса

Что я должен включить в заголовок документации моего класса
Что я должен включить в заголовок документации моего класса - hanzlog @ Unsplash

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

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

Было бы утомительно заглядывать в репозиторий каждый раз, когда вы хотите узнать другую информацию? Я бы сказал нет. Как часто вас волнует, кто был первоначальным автором? Или когда файл был впервые создан? Плагины (такие как Ankh SVN для Visual Studio) часто позволяют вам щелкнуть правой кнопкой мыши в текущем файле и просмотреть журнал репозитория для файла, поэтому просмотр этой информации не представляет особой сложности.

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

Рекомендую посмотреть эти видео для лучшего погружения в вопрос:

Прикрепленное видео 1 - 😂 Смешная презентация в школе! А ваш учитель оценил бы?

Прикрепленное видео 2 - Ты делал это в школе


LetsCodeIt, 21 мая 2023 г., 18:42