История изменений
Исправление firkax, (текущая версия) :
Документация должна объяснять в первую очередь идеологию работы твоего софта, без привязки к конкретным деталям кода. Справочник по коду - уже вторичен к этому. Если ты будешь это всё сувать в исходники, они станут замусоренными и неудобными с точки зрения кодинга. Точно так же, как сам код дробится на отдельные файлы разной специализации, надо и разделять документацию с кодом.
Исходная версия firkax, :
Документация должна объяснять в первую очередь идеологию работы твоего софта, без привязки к конкретным деталям кода. Справочник по коду - уже вторичен к этому. Если ты будешь это всё сувать в исходники, они станут замусоренными и неудобными с точки зрения кодинга.