Самоанализ с модулем осмотра
В мои первые годы с Python одна из вещей, которые мне действительно понравились,-это использование встроенного Помощь Функция для изучения классов и методов, сидя у интерпретатора, пытаясь определить, что печатать дальше. Эта функция импортирует объект и проходит через своих участников, вытаскивая Docstrings и генерируя вывод, похожий на Manpage, чтобы дать вам представление о том, как использовать объект, который он изучал.
Красота о том, что он встроена в стандартную библиотеку, заключается в том, что с выводом, создаваемым прямо из кода, он косвенно подчеркивает стиль кодирования для таких ленивых людей, как я, которые хотят выполнять как можно меньше дополнительной работы, чтобы поддерживать документацию. Особенно, если вы уже выбираете простые имена для ваших переменных и функций. Этот стиль включает в себя такие вещи, как добавление DocStrings в ваши функции и классы, а также должным образом идентифицируя частных и защищенных участников путем префикса их подчеркиванием.
Читать дальше …
Оригинал: “https://dev.to/tryexceptpass/how-to-write-your-own-python-documentation-generator-4f97”