PyCharm更改Docstrings格式和示例
修改方式
要更改此设置,请按此顺序选择选项。
Settings --> Tools --> Python Integrated Tools --> Docstring format
您可以从 5 种不同的样式中进行选择:
- Plain
- Epytext
- reStructuredText
- NumPy
样式Demo
这些是每种风格的Demo。
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 default)
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
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】博客园社区专享云产品让利特惠,阿里云新客6.5折上折
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· DeepSeek “源神”启动!「GitHub 热点速览」
· 微软正式发布.NET 10 Preview 1:开启下一代开发框架新篇章
· C# 集成 DeepSeek 模型实现 AI 私有化(本地部署与 API 调用教程)
· DeepSeek R1 简明指南:架构、训练、本地部署及硬件要求
· NetPad:一个.NET开源、跨平台的C#编辑器