こちらにある通り。 https://intellij-support.jetbrains.com/hc/en-us/community/posts/115000784410/comments/115000640424
[Settings → Tools → Python Integrated Tools → Docstring format]
の順に辿ることで変更可能。 選択可能なスタイルは5種類。
- Plain
- Epytext
- reStructuredText
- NumPy
以下にPyCharmによるそれぞれのスタイルの自動入力例を示す。
Plain
自動で入力しない。完全手動で書きたいときに。
def Foo(p1, p2, p3):
"""
"""
return 1, "str", True
- Epytext
def Foo(p1, p2, p3):
"""
@param p1:
@param p2:
@param p3:
@return:
"""
return 1, "str", True
reStructuredText
たぶんPyCharmデフォルト。
def Foo(p1, p2, p3):
"""
:param p1:
:param p2:
:param p3:
:return:
"""
return 1, "str", True
- NumPy
def Foo(p1, p2, p3):
"""
Parameters
----------
p1
p2
p3
Returns
-------
"""
return 1, "str", True
def Foo(p1, p2, p3):
"""
Args:
p1:
p2:
p3:
Returns:
"""
return 1, "str", True
