为构造函数和参数“self”编写docstring

问题描述 投票:-1回答:1

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

1.你为构造函数编写一个,如果是,你在参数docstring下添加“self”参数吗?你怎么形容它?

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

python-3.x class constructor self docstring
1个回答
0
投票

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

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

© www.soinside.com 2019 - 2024. All rights reserved.