そのため、Javadoc スタイルのドキュメントにはある程度慣れてきました。Python コードのさまざまな例を調べてみると、一見したところ、ドキュメンテーションには多くの情報が欠けているように見えます。
良い点: 自明なドキュメントを目にすることはめったにありません。Docstrings は通常、英語のマークアップの 1 段落以下であり、別々の行で目立つのではなく、統合されています。
悪い点: Python のダックタイピングと関連して、多くの関数が期待するパラメーターについて不明確であることがわかりました。型のヒント (ダック ヒンティング?) はありません。多くの場合、パラメーターはリストのように、文字列のように、ストリームのようにする必要があります。
もちろん、Javadoc は、Python の優れたイントロスペクション機能を持たない下位レベルの言語用に設計されています。
Python ドキュメントの標準とベスト プラクティスに関するアドバイスはありますか?