python学习笔记-为自定义类或者函数编写help文档，以及进行文档测试

那帮助文档一般会写什么内容呢？主要包括以下内容：

该类或者函数的主要作用

传入的值和输出的值

一些特殊情况的说明

文档测试内容

以上内容是个人的总结，但是并没有看到相关的资料。

我们来举一个例子：

class Apple(object):
""" This is an Apple Class"""
def get_color(self):
"""
Get the Color of Apple.
get_color(self) -> str
"""
return "red"

在python terminal输入

>>> from CallDemo import Apple
>>> help(Apple)
Help on class Apple in module CallDemo:
class Apple(__builtin__.object)
| This is an Apple Class
| 
 | Methods defined here:
| 
 | get_color(self)
| Get the Color of Apple.
| get_color(self) -> str
| 
 | ----------------------------------------------------------------------
| Data descriptors defined here:
| 
 | __dict__
| dictionary for instance variables (if defined)
| 
 | __weakref__
| list of weak references to the object (if defined)

利用doctest进行文档测试

我们在注释中我们也可以doctest模块进行文档测试。

例如，我们添加了文档测试内容后如下所示：

class Apple(object):
"""
This is an Apple Class
Example:
>>> apple = Apple()
>>> apple.get_color()
'red'
>>> apple.set_count(20)
>>> apple.get_count()
400
"""
def get_color(self):
"""
Get the Color of Apple.
get_color(self) -> str
"""
return "red"
def set_count(self, count):
self._count = count
def get_count(self):
return self._count * self._countif __name__ == '__main__':
import doctest

doctest.testmod()

由于我们写了

if __name__ == '__main__':
import doctest
doctest.testmod()

所以以上文档测试只有在以入口文件执行的时候才会进行文档测试。因此并不会在实际应用在执行文档测试。