我同意“您无法从方法签名中得知的任何内容”。这也可能意味着要解释方法/函数返回什么。
您可能还希望将Sphinx(和reStructuredText语法)用于文档字符串中的文档目的。这样,您可以轻松地将其包含在文档中。例如,请查看repoze.bfg,它广泛使用了此示例(示例文件,文档示例)。
可以放入文档字符串中的另一件事也是doctests。这可能特别有意义。对于模块或类文档字符串,您还可以通过这种方式说明如何使用它,并同时进行测试。
欢迎分享,转载请注明来源:内存溢出
我同意“您无法从方法签名中得知的任何内容”。这也可能意味着要解释方法/函数返回什么。
您可能还希望将Sphinx(和reStructuredText语法)用于文档字符串中的文档目的。这样,您可以轻松地将其包含在文档中。例如,请查看repoze.bfg,它广泛使用了此示例(示例文件,文档示例)。
可以放入文档字符串中的另一件事也是doctests。这可能特别有意义。对于模块或类文档字符串,您还可以通过这种方式说明如何使用它,并同时进行测试。
欢迎分享,转载请注明来源:内存溢出
评论列表(0条)