python中的文档变量

Question

如果在我的软件中间，我有一个变量，我需要解释它是什么，它是用来做什么的，我需要文件的变量。你知道吗

我有JS的背景，所以我是这样做的：

/**
 * Explain what the variable is, and what is for.
 * @variable {Object} nameOfVariable
 */
var nameOfVariable = []

对于python：

# ??
name_of_variable = []

这类事情有约定吗？你知道吗

非常感谢。你知道吗

Answer 1

是的，这就是我能找到的

https://www.python.org/dev/peps/pep-0257/

对于函数，您可以添加docstring，例如

def some_function():
  """ Write here a one line summary. 

If wanted, then leave a line and write a more detailed one"""

"""需要正确缩进才能工作

但是，对于散列#（在单变量之后更常见），它们不需要正确缩进。例如

some_variable = Something  # This variable is doing this...

希望对你有所帮助。你知道吗

Answer 2

PEP257文档称为docstrings，它是一个字符串文本，在模块、类、函数或方法的定义中作为第一个语句出现。据我所知，如果你想留下一些关于一个变量的信息，你可以在它附近留下常规的注释。例如：

# This is some variable ...
some_variable = ...

Answer 3

您可能会发现人们记录了参数、函数返回的内容，等等，但通常变量不会记录在python库中。你知道吗

这些名字通常应该是不言自明的。你知道吗