История изменений
Исправление foror, (текущая версия) :
К примеру взять исходники PostgreSQLи попробовать понять его архитектуру всего проекта и подсистем без документации можно? Можно.
Оно не ООП, поэтому так тяжело понять код без документации. Лучше потрать время на рефакторинг в ООП коде. Потратить время на грамотное название пакетов, классов и методов. Вместо написания документации.
Всё что нужно это в комментарии к точке запуска указать основные классы проекта. А в конкретных классах расписать идею положенную в данную реализацию. Плюс IDE и ЯП со строгой статичной типизацией, в котором доступна навигация по классам и методам. Всё.
Если пол года своей жизни на это потратить.
Если ты не специалист по разработке СУБД, ты основную часть времени потратишь на понимание архитектуры и алгоритмов работы СУБД. Дальше, при наличии ООП кода конечно, ты код любой СУБД будешь махом считывать без всяких комментариев.
Поэтому документация не нужна. В крайнем случае код можно скормить OpenAI.
Исходная версия foror, :
К примеру взять исходники PostgreSQLи попробовать понять его архитектуру всего проекта и подсистем без документации можно? Можно.
Оно не ООП, поэтому так тяжело понять код без документации. Лучше потрать время на рефакторинг в ООП коде, чем писать документацию.
Всё что нужно это в комментарии к точке запуска указать основные классы проекта. А в конкретных классах расписать идею положенную в данную реализацию. Плюс IDE и ЯП со строгой статичной типизацией, в котором доступна навигация по классам и методам. Всё.
Если пол года своей жизни на это потратить.
Если ты не специалист по разработке СУБД, ты основную часть времени потратишь на понимание архитектуры и алгоритмов работы СУБД. Дальше, при наличии ООП кода конечно, ты код любой СУБД будешь махом считывать без всяких комментариев.
Поэтому документация не нужна. В крайнем случае код можно скормить OpenAI.