为构造函数和参数“ self”编写文档字符串

时间:2018-08-31 07:15:32

标签: python-3.x class constructor self docstring

在python中为docstring类编写docstring numpy样式时,

1。您是否为构造函数编写了一个,如果是,您是否在参数docstring下添加了“ self”参数?您如何形容它?

  1. 如果方法不返回任何内容,您是否仍添加return部分并说“ None”? 这就是我要遵循的。

1 个答案:

答案 0 :(得分:0)

我不应该解释self,因为它是不言自明的。 Ba dum tss!

对于另一个问题,如果函数不返回任何内容,我不会添加返回说明,这足以说明函数在描述中的作用。