Python中函数添加注释 如何正确的为函数添加注释说明

鳄鱼君

发表文章数:642

Vieu四代商业主题

高扩展、安全、稳定、响应式布局多功能模板。

¥69 现在购买
首页 » Python » Python中函数添加注释 如何正确的为函数添加注释说明

在前面鳄鱼君对Python的注释只是简单的提示一下,没有详细说明,在这片文章中会对Python中的一些注释方法进行说明,它非常重要。

在Python中单行注释和多行注释非常的简单:

'''
多行注释
多行注释
'''
#单行注释

Python中文编码声明注释

Python 还提供了一种特殊的中文编码声明注释,其主要用来解决 Python 2.x 中不支持直接写中文的问题。虽然此问题在 Python 3.x 中已经不存在啦,但为了规范编码,增强代码的可执行性,方便其他程序员及时了解程序所用的编码,建议初学者在程序开头处加上中文编码声明注释。中文编码声明注释的语法有如下 2 种:

#!/usr/bin/env python   告诉LINUX/UNIX去找到python的翻译器
# -*- coding:编码 -*-
    或者
# coding=编码

语法中的编码,指的是编写程序所用的字符编码类型,比如 UTF-8、GBK 编码等。另外,在第一种语法中,‘-*-’并没有实际意义,只是为了美观才加上去了,因此,第一种语法格式中可以直接将前后的‘-*-’去掉。

Python函数的静态注释

单行中除了可以使用’#‘来对单行进行注释,也可以使用# type:的方式,来对返回的类型进行限制,如果在不知道返回类型的情况下,也可以自动补全代码,但是并不会检查语法或者代码逻辑上的错误。这个不常用,我也没试出来怎么玩,百度也没有具体的解释。

Python函数的动态注释

注释内容一般用于包括 对参数的类型的表示,多个参数用小括号

动态注释仅限与python的3.6版本。表现形式为:

def 函数名(参数)->类型:
def 函数名(参数1,参数2,…)-> (参数1类型,参数2类型,…):

我们来看一个简单的例子:

def func(x:int,y:int) -> (int):
   """
   :param x:
   :param y:
   :return:
   """
   return x+y
print(func(1,2))
print(help(func))
print(func('鳄鱼君','呃'))  #代码不规范 但不会报错
def func(name:str,age:int) -> (str,int):
   """
   :param name: 
   :param age: 
   :return: 
   """
   return '{0}:{1}'.format(name,age)
print(func('鳄鱼君',18))
def func(name:str= "",age:int ="") -> (str,int):
   """
   :param name:
   :param age:
   :return:
   """
   return '{0}:{1}'.format(name,age)
print(func())  
print(func('鳄鱼君',18))

鳄鱼君由于知识受限,没有办法彻底搞清楚,具体的使用方法参考上面的内容即可。

未经允许不得转载:作者:鳄鱼君, 转载或复制请以 超链接形式 并注明出处 鳄鱼君
原文地址:《Python中函数添加注释 如何正确的为函数添加注释说明》 发布于2020-04-08

分享到:
赞(3) 赏杯咖啡

评论 抢沙发

4 + 1 =


文章对你有帮助可赏作者一杯咖啡

支付宝扫一扫打赏

微信扫一扫打赏

Vieu4.6主题
专业打造轻量级个人企业风格博客主题!专注于前端开发,全站响应式布局自适应模板。
切换注册

登录

忘记密码 ?

您也可以使用第三方帐号快捷登录

Q Q 登 录
微 博 登 录
切换登录

注册