【Python】函数「五」——“写给别人看的“——关于函数书写规范

导读:本篇文章讲解 【Python】函数「五」——“写给别人看的“——关于函数书写规范,希望对大家有帮助,欢迎收藏,转发!站点地址:www.bmabk.com

这方面我也是抛砖引玉,具体来说有两个方法供大家参考

Python官方鼓励的类型标注

def add(a: int, b: int) -> int:
    return a + b

可以注意到,我为参数a、b和函数返回值都写明了类型,但仅仅是写明,Python并不会自动帮你检测,不过这种方式简洁明了,也是官方鼓励的。而当参数的类型有多种可能时,可以这样写:

def myprint(msg: list[str] or str="") -> None:
    if isinstance(msg, str):
        print(msg)
    else:
        print(", ".join(msg))

myprint()
myprint("hello world")
myprint(["hello", "world"])

为函数添加注释

不同的注释有不同的风格,我这里展示两种作为参考

第一种

def add(a: int, b: int) -> int:
    """a plus b

    Args:
        a (int): number
        b (int): number

    Returns:
        int: result
    """
    return a + b

第二种

def add(a: int, b: int) -> int:
    """
    a plus b
    :param a: int
    :param b: int
    :return: int
    """
    return a + b

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

文章由极客之音整理,本文链接:https://www.bmabk.com/index.php/post/97101.html

(0)
小半的头像小半

相关推荐

极客之音——专业性很强的中文编程技术网站,欢迎收藏到浏览器,订阅我们!