本文介绍了最常见的Python文档字符串格式是什么?的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着跟版网的小编来一起学习吧!
问题描述
我在Python中看到了几种不同样式的文档字符串,最流行的样式是什么?
推荐答案
格式
Python文档字符串可以按照其他帖子中显示的几种格式编写。但是,没有提到默认的Sphinx文档字符串格式,该格式基于睡觉。您可以在this blog post中获取有关主要格式的一些信息。
请注意,PEP 287推荐使用睡觉
以下是文档字符串的主要使用格式。
-电子邮件
历史上流行的是类似javadoc样式,因此将其作为Epydoc(称为Epytext
格式)生成文档的基础。
示例:
-睡觉
现在,可能更流行的格式是Sphinx用来生成文档的reStructiredText(睡觉)格式。 注意:在JetBrains PyCharm中默认使用它(定义方法后键入三重引号并按Enter键)。默认情况下,它也用作pyment中的输出格式。
示例:
Google有自己的经常使用的format。它也可以由狮身人面像(即.使用Napoleon plugin)。
示例:
偶数more examples
-Numpydoc
请注意,Numpy推荐遵循他们自己的numpydoc,基于Google格式,可由Sphinx使用。
转换/生成
可以使用像Pyment这样的工具自动生成尚未记录的Python项目的文档字符串,或者将现有文档字符串(可以混合多种格式)从一种格式转换为另一种格式。
注意:示例取自Pyment documentation
这篇关于最常见的Python文档字符串格式是什么?的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持跟版网!
本站部分内容来源互联网,如果有图片或者内容侵犯了您的权益,请联系我们,我们会在确认后第一时间进行删除!