有人可以告诉我以下文档字符串参数之间的区别吗?
:type
和 :param
我见过两者都用于指定方法参数的类型,但我认为它们的作用并不完全相同。其中一个用于程序员,另一个用于 IDE 还是类似的东西?
:rtype
、:return
和 :returns
特别是 :return 和 :returns 看起来非常相似,那么在什么情况下使用哪个呢?
最佳答案
这些约定由 Sphinx 文档工具使用,该工具最初是为处理 Python 文档而设计的。然而,它的流行导致它扩展到其他领域,定义于 the Sphinx documentation 中。作为“用于描述和链接到属于一起的对象的标记(reStructuredText指令和角色)的集合”。
根据链接页面 :return
来自 Python 域,:returns
来自 JavaScript 域,它们似乎都用于同一件事(< em>即记录函数或方法的返回值)。在实践中 :returns
很少出现,人们怀疑这是否是文档拼写错误。
:rtype
指定返回类型,并在可能的情况下创建指向类型定义的链接(即如果 Sphinx 可以在您正在记录的代码中找到定义) )。
关于Python 文档字符串 : What do these docstring parameters mean exactly?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/32412936/