如何编写有意义的文档字符串?

如何编写有意义的文档字符串?,第1张

如何编写有意义的文档字符串

我同意“您无法从方法签名中得知的任何内容”。这也可能意味着要解释方法/函数返回什么。

您可能还希望将Sphinx(和reStructuredText语法)用于文档字符串中的文档目的。这样,您可以轻松地将其包含在文档中。例如,请查看repoze.bfg,它广泛使用了此示例(示例文件,文档示例)。

可以放入文档字符串中的另一件事也是doctests。这可能特别有意义。对于模块或类文档字符串,您还可以通过这种方式说明如何使用它,并同时进行测试。



欢迎分享,转载请注明来源:内存溢出

原文地址: http://outofmemory.cn/zaji/5675058.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2022-12-16
下一篇 2022-12-16

发表评论

登录后才能评论

评论列表(0条)

保存