栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 面试经验 > 面试问答

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

面试问答 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

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

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

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

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



转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/669809.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号