Python类文档书写规范有哪些？

Python类文档书写规范包括使用三重引号编写类的docstring，docstring应该在类定义语句下的第一行，使用自然语言编写对类的描述，对参数、属性、方法等进行说明，使用reST格式对示例代码、返回值等进行说明。

相关问题

Python类文档书写规范有哪些？举个例子

Python类的文档书写规范如下：
1. 类声明前要有注释，注释第一行为类名称
2. 类注释应该包含类的用途，以及实例变量和方法等的简要描述
3. 类中的每个方法都应该有自己的文档字符串，描述该方法的用途、参数、返回值等
4. 类中的实例变量也应该有自己的文档字符串，描述该变量的用途、类型、范围等
5. 使用标准缩进（4个空格）来编写代码和注释

例如，一个名为Person的类的文档注释应该如下：

'''
Person类表示一个人的基本信息。

实例变量：
- name: 人的名字，类型为字符串
- age: 人的年龄，类型为整数

方法：
- say_hello(): 打招呼
- get_age(): 获取年龄
'''

class Person:
def __init__(self, name, age):
self.name = name
self.age = age

def say_hello(self):
print('你好，我叫{}'.format(self.name))

def get_age(self):
return self.age

Python函数文档书写规范有哪些？

Python函数文档应该至少包含函数的名称、参数、返回值和功能描述，如下所示：

def function_name(param1, param2):
    """
    Function description.

    :param param1: description of param1
    :param param2: description of param2
    :return: description of return
    """
    # function code

其中，函数描述应放在函数的第一行，并以三个引号括起来；参数和返回值应该用冒号隔开，前面加上一个参数名称或“return”。