Войти Открыть

Документация и комментарии

README и docstring для проекта

~1 минДокумент Word

Эта услуга пригодится, когда код уже работает, а объяснить его некому. Ты отдаёшь проект коллеге, возвращаешься к нему через полгода или готовишь его к публикации, и тут становится ясно: без README и docstring разобраться сложно.

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

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

Что получишь

Документ Word.

Что не входит: Код пишется без запуска в вашей среде: проверьте на тестовых данных перед использованием.

Что спросим при заказе

  • Код · развёрнутое описание

Вопросы

В каком виде нужен код?

Подойдёт исходный код проекта в том виде, в котором ты им пользуешься. Главное, чтобы он был читаемым и полным, а не отдельными кусками.

Что будет внутри документа Word?

README с описанием проекта и docstring для функций и модулей. То есть документ, по которому можно понять, как устроен код и что он делает.