Подготовку кода к передаче заказчику

[Alex A.]

Доброго времени суток.

Я на днях закончил писать небольшую аппликацию и, как только закончатся все дела с оплатой, мне нужно будет передать исходники заказчику.
В связи с этим у меня назрел вопрос: как правильно передавать код?
Минимум, что нужно сделать, это упорядочить комментарии в классах, методах и свойствах. Однако, мне кажется, что этого не достаточно.
Если через какое-то продолжительное время этот же заказчик обратится ко мне с просьбой изменить / дополнить существующий код, я бы не хотел тратить 100500 часов на воспоминания о том, что я там написал и о чем тогда думал. Так же мне не хочется, что б другие программисты, которые может будут тоже изменять / дополнять мой код, предали меня анафеме и сожгли мою куклу вуду. По-этому, думаю, нужно написать минимальную тех. характеристику или что-то подобное.
С другой стороны, я не хочу тратить много времени на подготовку кода к передаче заказчику.
А как бы вы поступили в этой ситуации?

С уважением, Саша.

[Murad Muradov]

Просто комментарии в классах, методах и свойствах достаточно.

[Alexander Byndyu]

Добрый день!

Зависит от задачи. Если хочется быстро разобраться в собственном коде, то покройте его тестами, хотя тесты должны быть по-умолчанию.

Если надо погрузить других разработчиков в проект, то опишите основные высокоуровневые идеи. Критерием качества будет понимание у стороннего человека как действовать, если хочется расширить/изменить/удалить/ускорить/... функциональность системы. Например, если важен выбор схемы БД, опишите ее особенности. Если вы специально и долго выбирали elasticsearch, то опишите как он влияет на проект и развитие системы.

Логика поиска ответов на вопросы описана здесь http://blog.byndyu.ru/2015/02/blog-post_10.html

On Tue, 23 Jan 2018 at 18:55, Murad Muradov <mpmu...@gmail.com> wrote:

Просто комментарии в классах, методах и свойствах достаточно.

--

---
Вы получили это сообщение, поскольку подписаны на группу "dotnetconf".
Чтобы отменить подписку на эту группу и больше не получать от нее сообщения, отправьте письмо на электронный адрес dotnetconf+...@googlegroups.com.
Чтобы настроить другие параметры, перейдите по ссылке https://groups.google.com/d/optout.

--

Best regards,
Alexander Byndyu
CEO at http://byndyusoft.com

+7 (904) 305 5263
http://blog.byndyu.ru
https://medium.com/@alexander.byndyu

[Alex A.]

Спасибо всем за ответы.

@Murad Muradov - В итоге я так и поступил, отправил код с комментариями.

@Alexander Byndyu - Покрытие тестами, дело хорошее, но для конкретного проекта "too match". Я искал более "дешёвый" вариант. Высокоуровневых идей, так же нет в проекте. Вся идея сводится к выборке данных из уже существующей базы данных и их сравнение с вновь полученными данными. Конечно можно написать, что я использую массивы, вместо списков, т.к. основная работа заключается в поиске а не внесении или удалении данных. Однако, это вряд ли поможет пониманию кода в будущем. Как я и описал выше, отправил код с комментариями и не более.
Отдельно спасибо за ссылку, обязательно просмотрю.

С уважением, Саша.