Классика — «я потом задокументирую» 📝
Не документирует. Через год открывает собственный проект и полдня разбирается, что тут происходит.
Отдельно бесполезны пояснения, которые пересказывают код своими словами. Через год они не помогают, а иногда и врут: код поменялся, а текст остался.
Писать надо не «что тут происходит», а «почему сделано именно так». Второе через год бесценно, первое видно и без подсказок 🗒
Тайны Вебмастера
@tayny_vebmastera
Классика — «я потом задокументирую» 📝
Этот пост опубликован в Telegram-канале Тайны Вебмастера. Подписаться можно по ссылке: @tayny_vebmastera.