2

我使用 python 编写了一个相对简单的脚本，还为所有方法编写了文档字符串，如下所示：

def processData(rawData):
    """Proccessing raw data from weather station using Regex to get final sensor readings.

    Args:
        rawData: A string contains all the sensor readings. This string will be processed
                 using regex to remove garbage.

    Returns:
        finalList: A list of final sensor readings."""

但是，当我尝试通过解释器打印文档字符串时，文档字符串被打印为“无”

>>> import ws100_weather_data as weather
>>> print weather.__doc__
None

但是 help(weather) 显示所有文档字符串以及其他信息。那么我在这里做错了吗？如果我是，访问文档字符串的正确方法是什么？

谢谢你。

4

2 回答 2

4

不同的对象有不同的文档字符串。您的函数的文档字符串将是processData.__doc__，对于模块它是weather.__doc__，您没有定义。将其定义为文件顶部全局范围内的裸字符串（未分配）。

于 2011-08-31T05:48:41.240 回答
1

您正在向我们展示一种方法的文档字符串。大概您没有该类的文档字符串。

于 2011-08-31T05:49:15.320 回答