参数数据类型的 Python 文档字符串 PEP257

问题描述

我正在尝试采用标准化所有文档字符串的标准方法，例如使用 reStructured 文本我可以有这样的东西：

def sample(name,age,marks):
    """"
    This is a method person info.
    :param str name: person name.
    :param int age: person age.
    :param int marks: person marks.
    
    :return User
    """
    
    return [name,marks]

对于我们有一个不是像上下文这样的数据结构的参数的场景，定义它的最好方法是什么，下面是示例函数。

def sample(name,marks,instance):
        """"
        This is a method person info.
        :param str name: person name.
        :param int age: person age.
        :param int marks: person marks.
        :param instance: Instance of an object.
    
        :return User
        """
    
        return [name,marks]

如果我没有数据结构，例如实例、上下文等会发生什么::

解决方法

暂无找到可以解决该程序问题的有效方法，小编努力寻找整理中！

如果你已经找到好的解决方法，欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@）