能给 python 函数的每个参数增加 docstring 吗？

2016-11-08 13:28:51 +08:00
 qweweretrt515

好让我们 用 ide 写代码的时候，指着调用函数的地方，就可以显示出 每个参数的具体含义，而不是根据参数名来猜测

1745 次点击
所在节点    Python
3 条回复
bazingaterry
2016-11-08 13:34:10 +08:00
PyCharm 有这功能来着……
qweweretrt515
2016-11-08 15:12:30 +08:00
@bazingaterry 我一般用的 vs code pycharm 偶尔用
ivechan
2016-11-08 22:56:31 +08:00
1. 在 function 的 docstring 里写, 参考 PEP-257 -> https://www.python.org/dev/peps/pep-0257/
2. Type Hint, 参考 PEP-484 -> https://www.python.org/dev/peps/pep-0484/

这是一个专为移动设备优化的页面（即为了让你能够在 Google 搜索结果里秒开这个页面），如果你希望参与 V2EX 社区的讨论，你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/318968

V2EX 是创意工作者们的社区，是一个分享自己正在做的有趣事物、交流想法，可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX