نوشتن DocString فرمتهای مختلفی دارد که ما
فرمت Google را به دلیل سادگی ترجیح دادیم.
برای اینکه داخل کد توضیحاتی بنویسید و بعد بتوانید هم توضیحات را به شکل فایلهای HTML استخراج کنید روشهای مختلفی وجود دارد. ما از mkDocs و mkDocStrings استفاده کردیم.
در سایت realPython
مقاله خوبی هست که تقریبا همه چیز را توضیح داده. من قسمتهای مهم آن را اینجا می آورم.
ادامه مطلب
درباره این سایت