2017-09-21 11 views
1

私は、ドキュメントストリングの作成に関して「ソリューションエコシステム」を理解し、PyCharm/IntelliJで素敵なリファレンスドキュメントを生成しようとしています。PyChrome/IntelliJはPythonドキュメントストリングにどのようなスタイルを使用しますか?

私は、Googleのスタイルのドキュメンテーション文字列に使用されていて、スケルトン形式/しかしスタイルのdocstring PyCharmのデフォルトで混乱しています:

""" 
:param <paramname>: blah blah 
:return None 
""" 

、これはどのようなスタイルで、どのような参照ドキュメントジェネレータそれはで動作んか?どこかにスタイルガイドがありますか?

+0

[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

答えて

2

これは、Sphinxスタイルのドキュメント文字列です。

Pythonには、doc文字列について強い意見があります。PEP257を参照してください。ここ

は、Pythonにおけるドキュメントの文字列型の全ての完全な説明である:What is the standard Python docstring format?

関連する問題