精华内容
下载资源
问答
  • Python 中如何写注释

    2020-12-17 01:37:05
    组织代码,设置变量,以及给函数有意义的名字,都是几个不错的方法。 另外一个提高代码可读性的方式就是使用注释。一个注释就是可以用来解释代码的一段人类可读的解释或者一个注解。例如,如果你了一个复杂的正则...
  • 组织代码,设置变量,以及给函数有意义的名字,都是几个不错的方法。 另外一个提高代码可读性的方式就是使用注释。一个注释就是可以用来解释代码的一段人类可读的解释或者一个注解。例如,如果你了一个复杂的正则...
     

    更多教程请到:菜鸟教程 https://www.piaodoo.com/

    在写 Python 代码的时候,一个很好的编码实践就是使得你的代码简洁,易懂。组织代码,设置变量,以及给函数有意义的名字,都是几个不错的方法。

    另外一个提高代码可读性的方式就是使用注释。一个注释就是可以用来解释代码的一段人类可读的解释或者一个注解。例如,如果你写了一个复杂的正则表达式,你可以添加一个注释,描述代码做了什么。

    在你的 Python 代码中添加注释,在将来你阅读你的代码时,可以节省很多的时间和努力。比如说,你想修改一段你在几个月前或者几年前写的脚本。很可能你不记得为什么你写了一些比较复杂的代码,除非你添加一段注释。这个注释同时也可以帮助其他开发者理解你的代码,以及代码的目的。

    注释应该很短,并且切中要点。不要解释那些很容易读懂的代码。

    本文主要讲解在 Python 中编写注释的基础知识。

    一、在 Python 中写注释

    Python 会忽略井号(#)后面的一切。

    注释可以添加到行首或者和其他代码在一行。

    # This is a Python comment.
    print("Hello World") # This is an inline Python comment.

    井号后面的空格不是强制性的,但是它会提高注释的可读性。

    在字符串中间的井号并不意味着是一段注释的开始。此时,它仅仅是一个简单的井号。

    paragraph = "# Hash inside quotes is not a comment."
    

    Comments should be at the same indent level as the code beneath it:

    def factorial(n):
     if n == 0:
     return 1
     else:
     # Use the factorial function
     return n * factorial(n-1)</pre>
    </div>
    <p>如果你的文本编辑器支持语法高亮,注释通常都使用绿色代表。</p>
    <p>注释在调试脚本的时候非常有用。与其删除一些行或者代码块,不如将他们暂时注释掉:</p>
    <div class="jb51code">
    <pre class="brush:py;">
    # for fruit in fruits:
    # print(fruit)</pre>
    </div>
    <p><strong>二、Python 中的多行注释(注释块)</strong></p>
    <p>不像其他流行的编程语言,Python 仅仅支持单行注释。</p>
    <p>在 Python 中编写多行注释的最简单方式就是每行添加一个注释。</p>
    <div class="jb51code">
    <pre class="brush:py;">
    # This is the first line.
    # This is the second line.</pre>
    </div>
    <p>另外一个选项就是使用 docstrings</p>
    <p>Docstrings 是一个多行字符串,用来对模块,函数,类和方法进行文档化的。</p>
    <p>一个 Docstrings 以(""") 开始,可以是 一行或者多行:</p>
    <div class="jb51code">
    <pre class="brush:py;">
    """This is
    a multiline
    docstring.
    """</pre>
    </div>
    <p>Docstrings 不是技术性的注释。当 Docstrings 在模块,函数,类,或者方法的前面出现的时候,它在字节码中结束,并且变成<code>__doc__</code>特殊属性的对象。</p>
    <p>你更应该使用单行注释。</p>
    <p><strong>三、Shebang</strong><br />
    </p>
    <p>如果你阅读 Python 脚本,你可能注意到第一行以<code>#!</code>字符开始,接着是 Python 解释器的路径。</p>
    <div class="jb51code">
    <pre class="brush:bash;">
    #!/usr/bin/env python3</pre>
    </div>
    <p>这一串字符串被称为<code>shebang</code>,它被用来告诉操作系统,应该使用什么解释器来解析文件。脚本以 shebang 开头,并且可以在终端中直接运行,而不用在脚本输入<code>python</code></p>
    <p>因为 shebang 以 井号开头,它被认为是一个注释,并且自动被 Python 解释器忽略。</p>
    <p><strong>四、总结</strong></p>
    <p>编写注释是一个非常好的实践,它帮助其他开发者,包括未来的自己,来理解这段代码在做什么。</p>
    <p>在 Python 中,所有以井号开头的直到行末的,都被认为是一段注释。</p>
    <p>以上就是Python 中写注释的方法的详细内容,更多关于python 注释的资料请关注菜鸟教程www.piaodoo.com其它相关文章!</p>
                            
                            
    
    展开全文
  • Python——为函数添加注释

    千次阅读 2019-11-03 19:37:59
    自己函数添加注释,并在调用自动补全时可以显示提示: 在函数定义下面使用'''进行注释 def read_json_file(file_name): ''' 从tweets中提取ID,并组成集合返回 ''' with open(file_name, "r", errors=...

    给自己写的函数添加注释,并在调用自动补全时可以显示提示:

    在函数定义下面使用'''进行注释

    def read_json_file(file_name):
    	'''
    		从tweets中提取ID,并组成集合返回
    	'''
    	with open(file_name, "r", errors="ignore") as f:
    		tweet_id_set = set()
    		for line in f:
    			json_obj = json.loads(line.strip())
    			tweetid = json_obj["tweetId"]
    			tweet_id_set.add(tweetid)
    		return tweet_id_set
    
    展开全文
  • 下面我们看看Python中如何给函数增加注释,以及如何获取一个函数的基本信息。 因为Python是解释运行的语言,增加注释和查看函数信息都需要一些方法实现。 如下,定义了一个将字符串生成MD5的函数,并且加了注释, ...

    下面我们看看Python中如何给函数增加注释,以及如何获取一个函数的基本信息。
    因为Python是解释运行的语言,增加注释和查看函数信息都需要一些方法实现。
    如下,定义了一个将字符串生成MD5的函数,并且加了注释,
    然后可以通过__doc__属性和help函数来获取函数的信息。

    import hashlib
    def genMd5(value):
        '生成MD5值'
        return hashlib.md5(value.encode(encoding='UTF-8')).hexdigest()
    
    print(genMd5('123'))
    
    print(genMd5.__doc__)
    print(help(genMd5))

    输出

    #print(genMd5('123'))的输出
    202cb962ac59075b964b07152d234b70
    
    #print(genMd5.__doc__)的输出
    生成MD5值
    
    #print(help(genMd5))的输出
    Help on function genMd5 in module __main__:
    genMd5(value)
        生成MD5值

    工程文件下载:https://download.csdn.net/download/yysyangyangyangshan/10764390

    展开全文
  • python函数注释1 注释1 def fun(name: str, age: '是一个大于零的整数值... 如果参数有默认值,还要给注释,如下。 age:'是一个大于零的整数值'=52 ->'返回值为真' 是函数返回值的注释。 这些注释信息都

    python的函数注释1

    注释1

    def fun(name: str, age: '是一个大于零的整数值' = 52) -> '返回值为真':
        """
        这个是函数的帮助说明文档,help时会显示
        函数声明中,name:str
        name 是参数 :冒号后面  str是参数的注释。
        如果参数有默认值,还要给注释,如下写。
        age:'是一个大于零的整数值'=52
        
        ->'返回值为真' 是函数返回值的注释。
        
        这些注释信息都是函数的元信息,保存在f.__annotations__字典中、
        
        需要注意,python对注释信息和f.__annotations__的一致性,不做检查
        不做检查,不做强制,不做验证!什么都不做。
        :param name:
        :param age:
        :return:
        """
        return True
    
    
    print(fun.__annotations__)
    

    打印结果如下:

    {'name': <class 'str'>, 'age': '是一个大于零的整数值', 'return': '返回值为真'}
    

    注释2

    def func(ham: 42, eggs: int = 'spam') -> "Nothing to see here":
        print("函数注释", func.__annotations__)
        print("参数值打印", ham, eggs)
        print(type(ham), type(eggs))
    
    
    func("www")
    

    打印结果:

    函数注释 {'ham': 42, 'eggs': <class 'int'>, 'return': 'Nothing to see here'}
    参数值打印 www spam
    <class 'str'> <class 'str'>
    

    解释说明:

    注释的一般规则是参数名后跟一个冒号(:),然后再跟一个expression,这个expression可以是任何形式。 返回值的形式是 -> int,annotation可被保存为函数的attributes。

    以上属于静态注释,还有一种方法叫做动态注释

    动态注释的原理,就是在函数中或者装饰器中动态的增加 删除 更改 注释内容

    f.annotations 是一个字典,可以使用字典的所有操作,这样就可以动态的更改注释了

    python 常用注释2

    def foo():
      """ This is function foo"""
    

    google风格

    """
    This is a groups style docs.
    
    Parameters:
      param1 - this is the first param
      param2 - this is a second param
    
    Returns:
        This is a description of what is returned
    
    Raises:
        KeyError - raises an exception
    """
    

    Rest 风格

    """
    This is a reST style.
    
    :param param1: this is a first param
    :param param2: this is a second param
    :returns: this is a description of what is returned
    :raises keyError: raises an exception
    """
    

    参考:python注释

    展开全文
  • 我们在 Python函数 或 自定义类 的时候,往往会需要里面的参数或者变量添加注释,这样的作用是使其他使用的人一个很好的说明,从而让他人更好的使用我们的代码 快速添加注释(Pycharm环境) 我们在好一个...
  • python函数注释: def f(text:str,max_len:'int...如果参数有默认值,还要给注释,如下。 max_len:'int>0'=80 ->str 是函数返回值的注释。 这些注释信息都是函数的元信息,保存在f.__annotations__字典中
  • python函数注释: def f(text:str,max_len:'int>0'=80) ->str: """这个是函数的帮助说明文档,help时会显示""" ...如果参数有默认值,还要给注释,如下。 max_len:'int>0'=80 ->...
  • 注释是编写程序时,程序的人一个语句、程序段、函数等的解释或提示,能提高程序代码的可读性。在有处理逻辑的代码中,源程序有效注释量必须在20%以上。相关学习推荐:python视频教程二、代码注释分类行注释:在...
  • 注释是编写程序时,程序的人一个语句、程序段、函数等的解释或提示,能提高程序代码的可读性。在有处理逻辑的代码中,源程序有效注释量必须在20%以上。二、代码注释分类行注释:在符号后那一行不会被编译(显示...
  • 本篇文章小编大家分享一下Python代码...注释是编写程序时,程序的人一个语句、程序段、函数等的解释或提示,能提高程序代码的可读性。在有处理逻辑的代码中,源程序有效注释量必须在20%以上。二、代码注释...
  • python函数

    2016-08-29 16:49:34
    1. 创建函数def 函数名(参数):函数体... 文档化函数def square(x):'calculate the square of the number'return x*x给函数写文档让别人容易理解,可以加入注释(以#开头),或者直接写上文档字符串文档字符串...
  • python基础 函数

    2017-12-27 15:07:00
    虽然函数名可以随便起,但我们给函数起名字还是要尽量简短,并能表达函数功能  括号:是必须加的  注释:每一个函数都应该对功能和参数进行相应的说明,应该在函数下面第一行。以增强代码的可读性。...
  • python 函数

    2019-08-04 14:49:12
    这里写函数注释 """ 这里代码,如果是空的函数,用pass来占位结构 # 调用函数 函数名() 带参函数 定义时,函数小括号里的参数称为是形参 调用函数时,小括号里参数是实参 def p(a, b): ...
  • 2.函数的文档注释 3.函数的参数与调用 4.函数参数的类型(重点) 5.函数的返回值 6.函数的嵌套调用 7.局部变量和全局变量 所谓函数,就是把具有独立功能的代码块组织为一个小模块,在需要的时候调用。 函数...
  • Eel——js 如何调用python函数

    万次阅读 热门讨论 2018-06-22 15:26:16
    它拥有一个本地网络服务器,然后让你用Python注释函数,以便从Javascript调用它们,反之亦然。 无可避免的,若要从后端语言获取数据,必须得开个服务器,Eel可以免去服务器 pip install eel # 安装eel 把...
  • 需求:编写程序时, 程序的人一个语句、程序段、函数等的解释或提示, 能提高程序代码的可读性. 定义:对代码的解释和说明 目的:让人们能够更加轻松地了解代码 单行注释 # 这是单行...
  • Python里的一些注释规范

    万次阅读 2017-09-19 22:26:34
    代码注释是一件很重要的事情,如果你的一段函数给别人调用那么往往都需要配上一些基本的注释好代码可以让别人容易阅读你的代码。试想一 下:如果你在github上面找到一段你想要的代码,这段代码有200行,可能...
  • python3 注释

    2021-05-25 10:43:43
    注释是编写程序时,程序的人一个语句、程序段、函数等的解释或提示,能提高程序代码的可读性。 注释只是为了提高可读性,不会被计算机编译。 python有多行注释和单行注释; 1. 单行注释 以 # 开头,#后面的都...
  • docstring也就是给代码加注释的内容了,python可以给函数,类、方法,模块添加注释内容,注释标准格式一般是三个双引号,如:"""美程序员枪击4同事,竟因代码不写注释?""" docstring 先看一个简单案例,在函数里面...
  • 注意,代码之前要切换成英文输入状态,括号、符号和标点必须是英文状态下的括号 本文输入的都是演示代码,没有结果,可以自己去调试来验证,有问题的希望我反馈 不带引号 括号里直接输入数字或数字间的运算 例...
  • 注释是编写程序时,程序的人一个语句、程序段、函数等的解释或提示,能提高程序代码的可读性。在有处理逻辑的代码中,源程序有效注释量必须在20%以上。二、代码注释分类行注释:在符号后那一行不会被编译(显示...

空空如也

空空如也

1 2 3 4 5 ... 10
收藏数 199
精华内容 79
关键字:

python给函数写注释

python 订阅