Как я могу эффективно понять структуру с редкой документацией?

Question

У меня проблема в том, что для проекта мне нужно работать с фреймворком (Python), у которого плохая документация.Я знаю, что он делает, так как это серверная часть работающего приложения.Я также знаю, что никакая структура не хороша, если документация плоха, и что я должен исследовать.закодируй это сам.Но у меня есть ограничение по времени.Поэтому мой вопрос таков: есть ли рецепт приготовления, как понять плохо документированные рамки?

До сих пор я пытался проверить некоторые функции и определить организационные единицы в структуре, но мне не хватает системы, чтобы сделать это более эффективно.

Answer 1

Вы также можете использовать библиотеку отладки Python: pdb . После импорта с помощью import pdb вы можете установить трассировки в теле функций и классов pdb.set_trace(). Затем он остановит выполнение программы в строке, и вы можете посмотреть на существующие переменные и процессы.

Answer 2

Если бы я был вами, с ограничениями по времени и обязан использовать определенные рамки.Я пойду следующим образом:

• Перечислите варианты использования, которые я хочу реализовать, используя платформу
• Определите API, предоставляемые платформой, которые помогают мне реализовать варианты использования
• Прототипирование прецедентов на основе имеющейся документации и чтения

Прототипирование реализует не весь вариант использования, а идентификацию строительных блоков вокруг корпуса и их реализацию.Например, если мой вариант использования заключается в получении Студентов вместе с их курсами, и если я использую Hibernate для реализации, я прототипирую доступ к базе данных, проверяя, насколько легко я могу получить доступ к базе данных, используя Hibernate, или насколько легко явозможность получать реляционные данные посредством объединения / агрегирования и т. д.

Прототипирование поможет мне выяснить возможные ограничения / ошибки в структуре.Если ограничения больше ограничивают показ, я сам реализую поддерживающие API;или я могу взять вызов, чтобы удалить всю структуру и написать один для себя;что имеет больше смысла.