我对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
我使用PyCharmIDE来协助制作符合PEP0257的文档字符串。它提供了两个属性，我不完全理解它们之间的区别/用途::raiseException:此处异常说明:raisesException:这里有异常说明我什么时候在我的文档字符串中使用raise作为与raises的对立面？具体来说，如果一个类需要一个未提供的参数并引发TypeError，那么应该使用它来记录吗？ 最佳答案 TL;DRraises用于描述可能引发的异常。raise被Sphinx识别运行autodoc时，与raises相同。完整说明PyCharm有助于使用几种不
我使用PyCharmIDE来协助制作符合PEP0257的文档字符串。它提供了两个属性，我不完全理解它们之间的区别/用途::raiseException:此处异常说明:raisesException:这里有异常说明我什么时候在我的文档字符串中使用raise作为与raises的对立面？具体来说，如果一个类需要一个未提供的参数并引发TypeError，那么应该使用它来记录吗？ 最佳答案 TL;DRraises用于描述可能引发的异常。raise被Sphinx识别运行autodoc时，与raises相同。完整说明PyCharm有助于使用几种不
我如何记录一个函数返回一个tuple以使PyCharm能够使用它进行类型提示？人为的例子:deffetch_abbrev_customer_info(customer_id):"""PullsabbreviatedcustomerdatafromthedatabasefortheCustomerwiththespecifiedPKvalue.:typecustomer_id:intTheIDoftheCustomerrecordtofetch.:rtype:???"""...magichappenshere...returncustomer_obj.fullname,customer_
我如何记录一个函数返回一个tuple以使PyCharm能够使用它进行类型提示？人为的例子:deffetch_abbrev_customer_info(customer_id):"""PullsabbreviatedcustomerdatafromthedatabasefortheCustomerwiththespecifiedPKvalue.:typecustomer_id:intTheIDoftheCustomerrecordtofetch.:rtype:???"""...magichappenshere...returncustomer_obj.fullname,customer_
我想在Python文档字符串的其他地方引用以前记录的函数参数。考虑以下(诚然完全人为的)示例:deffoo(bar):"""Performfooaction:parambar:Thebarparameter"""defnested():"""Somenestedfunctionthatdependsonenclosingscope'sbarparameter.I'dliketoreferencefunctionfoo'sbarparameterherewithalink,isthatpossible?"""returnbar*bar#...returnnested()有没有一种使用Sp
我想在Python文档字符串的其他地方引用以前记录的函数参数。考虑以下(诚然完全人为的)示例:deffoo(bar):"""Performfooaction:parambar:Thebarparameter"""defnested():"""Somenestedfunctionthatdependsonenclosingscope'sbarparameter.I'dliketoreferencefunctionfoo'sbarparameterherewithalink,isthatpossible?"""returnbar*bar#...returnnested()有没有一种使用Sp
所以我正在尝试创建一个类似这样的“动态”文档字符串:ANIMAL_TYPES=["mammals","reptiles","other"]deffunc(animalType):"""Thisisasamplefunction.@paramanimalType:"Ittakesoneoftheseanimaltypes%s"%ANIMAL_TYPES"""基本上让@paramanimalType的文档字符串显示ANIMAL_TYPES的任何内容；这样当这个变量被更新时，文档字符串就会自动更新。不幸的是，它似乎不起作用。有谁知道是否有办法实现这一目标？ 最佳答
所以我正在尝试创建一个类似这样的“动态”文档字符串:ANIMAL_TYPES=["mammals","reptiles","other"]deffunc(animalType):"""Thisisasamplefunction.@paramanimalType:"Ittakesoneoftheseanimaltypes%s"%ANIMAL_TYPES"""基本上让@paramanimalType的文档字符串显示ANIMAL_TYPES的任何内容；这样当这个变量被更新时，文档字符串就会自动更新。不幸的是，它似乎不起作用。有谁知道是否有办法实现这一目标？ 最佳答
