已结束。此问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提出有关书籍、工具、软件库等方面的建议的问题。您可以编辑问题，以便用事实和引用来回答它。关闭6年前。Improvethisquestionpep8等工具可以检查源代码样式，但他们不检查文档字符串是否根据pep257,pep287.有这样的工具吗？更新我决定自己实现这样一个静态分析工具，见:https://github.com/GreenSteam/pep257现在，大部分pep257被覆盖。设计深受提到的pep8的影响。工具。 最佳答案
已结束。此问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提出有关书籍、工具、软件库等方面的建议的问题。您可以编辑问题，以便用事实和引用来回答它。关闭6年前。Improvethisquestionpep8等工具可以检查源代码样式，但他们不检查文档字符串是否根据pep257,pep287.有这样的工具吗？更新我决定自己实现这样一个静态分析工具，见:https://github.com/GreenSteam/pep257现在，大部分pep257被覆盖。设计深受提到的pep8的影响。工具。 最佳答案
有时Python中的函数可以接受灵活类型的参数。或者它可能返回一个灵活类型的值。现在我记不起这样的函数的一个很好的例子了，因此我用下面的玩具例子来演示这样的函数可能是什么样子。我想知道如何使用Sphinx文档符号为此类函数编写文档字符串。在下面的示例中，参数可以是str或int。同样，它可能返回str或int。我已经给出了一个示例文档字符串(包括默认的Sphinx表示法以及Sphinx的拿破仑扩展所理解的Google表示法)。我不知道这是否是记录灵活类型的正确方法。Sphinx默认表示法:defadd(a,b):"""Addnumbersorconcatenatestrings.:pa
有时Python中的函数可以接受灵活类型的参数。或者它可能返回一个灵活类型的值。现在我记不起这样的函数的一个很好的例子了，因此我用下面的玩具例子来演示这样的函数可能是什么样子。我想知道如何使用Sphinx文档符号为此类函数编写文档字符串。在下面的示例中，参数可以是str或int。同样，它可能返回str或int。我已经给出了一个示例文档字符串(包括默认的Sphinx表示法以及Sphinx的拿破仑扩展所理解的Google表示法)。我不知道这是否是记录灵活类型的正确方法。Sphinx默认表示法:defadd(a,b):"""Addnumbersorconcatenatestrings.:pa
所以，reStructuredText是therecommendedway对于Python代码文档，如果你足够努力，你可以findinthesphinxdocumentation如何规范您的函数签名文档。所有给出的例子都是单行，但如果参数描述是多行，如下所示?deff(a,b):"""Doessomethingwithaandb:parama:somethingsimple:paramb:well,it'snotsomethingsimple,soitmayrequiremorethaneightychars"""它的语法/约定是什么？我应该缩进还是不缩进？它会破坏reSTructur
所以，reStructuredText是therecommendedway对于Python代码文档，如果你足够努力，你可以findinthesphinxdocumentation如何规范您的函数签名文档。所有给出的例子都是单行，但如果参数描述是多行，如下所示?deff(a,b):"""Doessomethingwithaandb:parama:somethingsimple:paramb:well,it'snotsomethingsimple,soitmayrequiremorethaneightychars"""它的语法/约定是什么？我应该缩进还是不缩进？它会破坏reSTructur
编写Python文档字符串的首选方法是什么？"""或"在书中DiveIntoPython，作者提供如下示例:defbuildConnectionString(params):"""Buildaconnectionstringfromadictionaryofparameters.Returnsstring."""在另一个chapter，作者再举一个例子:defstripnulls(data):"stripwhitespaceandnulls"returndata.replace("\00","").strip()两种语法都有效。对我来说唯一的区别是"""允许我们编写多行文档。除此之外还
编写Python文档字符串的首选方法是什么？"""或"在书中DiveIntoPython，作者提供如下示例:defbuildConnectionString(params):"""Buildaconnectionstringfromadictionaryofparameters.Returnsstring."""在另一个chapter，作者再举一个例子:defstripnulls(data):"stripwhitespaceandnulls"returndata.replace("\00","").strip()两种语法都有效。对我来说唯一的区别是"""允许我们编写多行文档。除此之外还
我对python中的文档字符串和注释之间的区别有点困惑。在我的类里面，我的老师介绍了一种被称为“设计秘诀”的东西，一组步骤据说可以帮助我们学生更好地用Python绘制和组织我们的编码。据我了解，以下是我们遵循的步骤的示例-这就是所谓的设计配方(引用中的内容):defterm_work_mark(a0_mark,a1_mark,a2_mark,ex_mark,midterm_mark):'''(float,float,float,float,float)->floatTakesyourmarksona0_mark,a1_mark,a2_mark,ex_markandmidterm_mar
我对python中的文档字符串和注释之间的区别有点困惑。在我的类里面，我的老师介绍了一种被称为“设计秘诀”的东西，一组步骤据说可以帮助我们学生更好地用Python绘制和组织我们的编码。据我了解，以下是我们遵循的步骤的示例-这就是所谓的设计配方(引用中的内容):defterm_work_mark(a0_mark,a1_mark,a2_mark,ex_mark,midterm_mark):'''(float,float,float,float,float)->floatTakesyourmarksona0_mark,a1_mark,a2_mark,ex_markandmidterm_mar
