1
私は、ドキュメントストリングの作成に関して「ソリューションエコシステム」を理解し、PyCharm/IntelliJで素敵なリファレンスドキュメントを生成しようとしています。PyChrome/IntelliJはPythonドキュメントストリングにどのようなスタイルを使用しますか?
私は、Googleのスタイルのドキュメンテーション文字列に使用されていて、スケルトン形式/しかしスタイルのdocstring PyCharmのデフォルトで混乱しています:
"""
:param <paramname>: blah blah
:return None
"""
、これはどのようなスタイルで、どのような参照ドキュメントジェネレータそれはで動作んか?どこかにスタイルガイドがありますか?
[reStructuredTextの(https://stackoverflow.com/questions/45081675/ive-been-using-this-すなわちdocstring-syntax-for-2-years-now-whats-it-called-who-spe)のdocstringスタイルです。そのスタイルは[PEP 287](https://www.python.org/dev/peps/pep-0287/)で指定されています。 – CoryKramer