精华内容
下载资源
问答
  • 如何在python中写注释
    千次阅读
    2020-11-30 04:27:05

    python如何写注释

    1. 为什么要写注释

    如果你多了解一些编程语言,你就能够发现一个特别神奇的现象,所有的编程语言都允许你写注释,而在很多初学者眼中,注释并不是什么重要的东西,学习过程中几乎没有太多的关注。

    但在实际工作中,注释是非常重要的,甚至有观点认为注释是程序的一部分,为什么在专业人士眼中,代码注释如此重要呢?其实原因很简单,你今天写的代码,7天以后你自己都不认识了。

    就是这么不可思议,但又很合理,你还记得7天前晚饭吃的是什么?代码,是你大脑里逻辑的一种技术呈现,彼时彼刻,你所思所想浓缩成了一行行的代码,但是7天以后,这一行行代码却很难反向转换成你大脑里的逻辑,这就是写注释的必要所在。

    注释的目的是解释代码在做什么,关键性的信息可以让你在回顾代码时回想起更多的更完整的信息。

    对于初学者,给代码写注释,更有助于理清代码逻辑,让思维更严谨。

    2. 注释的写法

    2.1 单行注释

    单行注释以 # 开头,根据规范,注释内容与# 间隔一个空格

    count = 0 # 记录数量

    2.2 多行注释

    多行注释,可以用三个单引号,或者三个双引号括起来

    def recursion(number):

    """

    计算number的阶乘

    :param number:

    :return:

    """

    if number == 1:

    return 1

    next_recursion = recursion(number-1)

    return next_recursion*number

    if __name__ == '__main__':

    print(recursion(4))

    或者

    def recursion(number):

    '''

    计算number的阶乘

    :param number:

    :return:

    '''

    多行注释多用于函数,类,模块

    3. 什么注释算是好注释

    关于这个问题,没有标准答案,有人很抬杠的说代码是最好的注释,这等于没说,正是因为写出好代码不是一件容易的事情,所以,才要写注释。

    结合我自身的工作经验,我认为好的代码注释应该符合以下几个特点

    描述简洁,避免长篇大论

    保留关键上下文信息

    多记录为什么,少说是什么

    描述简洁,避免长篇大论

    如果把一段代码注释写成了议论文,那岂不是喧宾夺主,注释应该简洁,减轻阅读负担。

    注释内容要直观,比如给一个函数写注释,要简明的描述函数的功能和作用。

    保留关键上下文信息

    只有写代码的人才了解上下文信息,而对于维护代码的人来说,这些信息往往是缺失的,比如给一个函数写注释,如果函数是一个功能函数,那么注释应该说清楚它的适用范围,如果是一个对外的接口,那么应该说清楚目前谁在调用,入参需要注意的问题是什么。

    保留这些上下文信息,可以让接手的人快速的了解这个函数,不至于到处去问人,

    多记录为什么,少说是什么

    和第一条遥相呼应,代码做了什么,简明扼要的介绍就可以了,但是为什么要这么做则需要多做些说明。

    如果接手代码的人不清楚为什么要这么做,很可能会认为你的代码写的有问题,因为他不了解需求背景,他不了解当初写代码时的考虑因素和限制条件,所以,注释应当为后来人释疑,让维护代码的人大胆放心的使用,而不是质疑你的代码

    更多相关内容
  • 超详解python中注释

    2020-12-20 19:56:27
    在python中使用“#”作为单行注释的符号,从符号“#”开始直到换行为止,“#”后面所有的内容都作为注释的内容。 单行注释可以放在要注释代码的前一行,也可以放在要注释代码的右侧。 # 第一个注释 print ("Hello, ...
  • 本文实例讲述了Python文件去除注释的方法。分享给大家供大家参考。具体实现方法如下: #!/usr/bin/python # -*- coding: GBK -*- #writer:xmnathan #py文件去注释 import re import os import ConfigParser\nPython...
  • Python中注释

    千次阅读 2021-03-17 17:38:57
    1.1 注释的目的通过用自己熟悉的语言,程序对某些代码进行标注说明,这就是注释的作用,能够大大增强程序的可读性。1.2 注释的分类1.2.1 单行注释以#开头,#右边的所有东西当做说明,而不是真正要执行的程序,起...

    1.1 注释的目的

    通过用自己熟悉的语言,在程序中对某些代码进行标注说明,这就是注释的作用,能够大大增强程序的可读性。

    1.2 注释的分类

    1.2.1 单行注释

    以#开头,#右边的所有东西当做说明,而不是真正要执行的程序,起辅助说明作用

    # 我是注释,可以在里写一些功能说明之类的哦

    print('hello world')

    pycharm里面快捷键 Ctrl + /

    1.2.2 多行注释

    '''

    我是多行注释,可以写很多很多行的功能说明

    这就是我牛X指出

    哈哈哈。。。

    '''

    '''

    下面的代码完成 ,打印一首诗

    名字叫做:春江花月夜

    作者,忘了

    '''

    print('╔═╤═╤═╤═╤═╤═╤═╤═╤═╤═╤═╤═╤═╤═╤═╤═╤═╤═╤═╤═╗')

    print('║ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │  ║')

    print('║ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ║')

    print('║ │春│滟│江│空│江│江│人│不│白│谁│可│玉│此│鸿│昨│江│斜│不│ ║')

    print('║ │江│滟│流│里│天│畔│生│知│云│家│怜│户│时│雁│夜│水│月│知│ ║')

    print('║ │潮│随│宛│流│一│何│代│江│一│今│楼│帘│相│长│闲│流│沉│乘│ ║')

    print('║ │水│波│转│霜│色│人│代│月│片│夜│上│中│望│飞│潭│春│沉│月│ ║')

    print('║ │连│千│绕│不│无│初│无│待│去│扁│月│卷│不│光│梦│去│藏│几│ ║')

    print('║春│海│万│芳│觉│纤│见│穷│何│悠│舟│徘│不│相│不│落│欲│海│人│ ║')

    print('║江│平│里│甸│飞│尘│月│已│人│悠│子│徊│去│闻│度│花│尽│雾│归│ ║')

    print('║花│,│,│,│,│,│,│,│,│,│,│,│,│,│,│,│,│,│,│ ║')

    print('║月│海│何│月│汀│皎│江│江│但│青│何│应│捣│愿│鱼│可│江│碣│落│ ║')

    print('║夜│上│处│照│上│皎│月│月│见│枫│处│照│衣│逐│龙│怜│潭│石│月│ ║')

    print('║ │明│春│花│白│空│何│年│长│浦│相│离│砧│月│潜│春│落│潇│摇│ ║')

    print('║ │月│江│林│沙│中│年│年│江│上│思│人│上│华│跃│半│月│湘│情│ ║')

    print('║ │共│无│皆│看│孤│初│望│送│不│明│妆│拂│流│水│不│复│无│满│ ║')

    print('║ │潮│月│似│不│月│照│相│流│胜│月│镜│还│照│成│还│西│限│江│ ║')

    print('║ │生│明│霰│见│轮│人│似│水│愁│楼│台│来│君│文│家│斜│路│树│ ║')

    print('║ │。│。│。│。│。│?│。│。│。│?│。│。│。│。│。│。│。│。│ ║')

    print('║ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ║')

    print('║ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ║')

    print('╚═╧═╧═╧═╧═╧═╧═╧═╧═╧═╧═╧═╧═╧═╧═╧═╧═╧═╧═╧═╝')

    Python中的注释(转)

    一.单行注释     单行注释以#开头,例如:     print 6 #输出6 二.多行注释     (Python的注释只有针对于单行的注释(用#),这是一种变通的方法)      多行注释用三引 ...

    使用sphinx自动提取python中的注释成为接口文档

    写好了代码,交付给他人使用的时候,查看代码固然可以了解各类和函数的功能细节,但接口文档能更方便的查找和说明功能.所以,一价与代码同步的接口文档是很有必要的.sphinx可以根据python中的注释,自 ...

    怎样在python中写注释

    python中的注释是以井号: # 开头, 一般会在#后加一个空格. # This is a comment print("Hello, World!") 多行注释的语法是三引号: ...

    python学习笔记(1)python中的注释和安装python

    注释 目标 注释的作用 单行注释 多行注释 01注释的作用 在程序中对代码的标注说明,增强代码的可读性 以 # 开头,# 右边的所有东西都被当做说明文字,而不是真正要执行的程序,只起到辅助说明作用 为 ...

    python中的注释,输入输出和编码及文件

    1.单行注释 以井号( # )开头,右边的所有内容当做说明2.多行注释 以三对单引号(’’’注释内容’’’)将注释包含起来以‘# ’是注释的标识符,可以记录当前代码所代表的意义,解释器会自动忽略这部分 ...

    Python中的注释和解注释

    注释 目标 注释的作用 单行注释(行注释) 多行注释(块注释) 01. 注释的作用 使用用自己熟悉的语言,在程序中对某些代码进行标注说明,增强程序的可读性 02. 单行注释(行注释) 以 # 开头,# ...

    python中注释的写法

    说明: 记录在python中注释的写法. 1.单行注释,代码行以 # 开头 # 这是一个单行注释 print('hello world') 2.多行注释,使用三个单引号,或者三个双引号将其要注释的内容 ...

    Python中注释的添加

    1.Python中注释,有助于我们对程序的理解:但注释不需要每行都写,可以在方法前面注释该方法的功能 或重要的一行进行注释. 2.单行注释,使用#号: 3.多行注释,使用""&qu ...

    python中注释的书写

    与c和c++的//不同的是,在python中我们使用#来进行注释 每个#所在的那一行都可以叫做注释:

    随机推荐

    ssl + nginx + tomcat 部署方案

    安装make yum -y install gcc automake autoconf libtool make 安装g++ yum install gcc gcc-c++ 安装PCRE cd /us ...

    thinkPHP-空操作

    空操作 当访问的方法不存在时,可以定义一个empty方法来避免空操作 function _empty() { echo "网页不存在,请检查地址信息"; } 这样当访问不存在的方法 ...

    AFNetworking 之于 https 认证

    写在开头: 本来这篇内容准备写在AFNetworking到底做了什么?(三)中的,但是因为我想在三中完结这个系列,碍于篇幅所限.并且这一块内容独立性比较强,所以单独拎出来,写成一篇. 本文从源码的角度 ...

    webView 加载本地文件 - html/htm pdf docx tx

    - (void)viewDidLoad { [super viewDidLoad]; [self setupUI]; NSString *path = [[NSBundle mainBundle] p ...

    【UVA1633】禁止的回文串(状压DP)

    题意: 输入正整数n和k(1<=n<=400,1<=k<=10),求长度为n的01串中有多少个不含长度至少为k的回文连续子串.例如,n=k=3时只有4个串满足条件:001,01 ...

    hibernate---一对一单向主键关联&lpar;不重要&rpar;

    比如, husband的id参考wife的id husband.java: package com.bjsxt.hibernate; import javax.persistence.Entity; ...

    2017多校第10场 HDU 6181 Two Paths 次短路

    题目链接:http://acm.hdu.edu.cn/showproblem.php?pid=6181 题意:给一个图,求出次短路. 解法:我之前的模板不能解决这种图,就是最短路和次短路相等的情况,证 ...

    day12函数,三元表达式 ,列表推导式 ,字典推导式,函数对象,名称空间与作用域,函数的嵌套定义

    复习 # 字符串的比较 # -- 按照从左往右比较每一个字符,通过字符对应的ascii进行比较 # 函数的参数 # 1)实参与形参: # -- 形参:在函数定义时()中出现的参数 # -- 实参:在函 ...

    配置IPMI

    服务器电源管理 查看服务器电源状态 ipmitool chassis power status 关闭服务器电源 ipmitool chassis power off 打开服务器电源 ipmitool ...

    DRF跨域&comma;简单请求和复杂请求

    跨域就是跨域名,跨端口 - 为什么会有跨域? 浏览器有同源限制策略 - 绕过浏览器同源策略就可以跨域 -  方式一: jsonp(利用浏览器特性) 在html动态创建script标签 同源策略会阻止a ...

    展开全文
  • Python 如何写注释

    2020-09-16 08:59:23
    主要介绍了如何 Python 中注释,帮助其他开发者理解你的代码,以及代码的目的。感兴趣的朋友可以了解下
  • python基础教程Python 如何写注释

    千次阅读 2020-11-07 09:04:19
    在写 Python 代码的时候,一个很好的编码实践就是使得你的代码简洁,易懂。组织代码,设置变量,以及给函数有...你的 Python 代码添加注释将来你阅读你的代码时,可以节省很多的时间和努力。比如说,你.

    更多教程请到:菜鸟教程 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代码添加注释 Python中的变量的使用 Python中的数据类型 Python中的关键字 Python字符串操作 Python中的list操作 Python中的Tuple操作 Pythonmax()和min()–列表或数组查找最大值和最小值 Python...
  • 确保对模块, 函数, 方法和行内注释使用正确的风格,Python中注释有单行注释和多行注释。如果希望去除文件所有注释,如何做呢? Python中注释Python中单行注释以 # 开头,例如: # 这是一个注释 print(...
  • python中怎么注释多行

    千次阅读 2022-01-04 19:07:18
    方法二:跟注释单行一样每一行前面输入“shift+#”。对于新手小白想更轻松的学好Python基础,Python爬虫,web开发、大数据,数据分析,人工智能等技术,这里给大家分享系统教学资源,架下我尉(同英): 2763 177 ...

    image

    多行代码注释

    方法一:先选中要注释的段落,然后按下“ctrl+/”,即可实现多行代码的注释。效果如下:

    image

    再一次按下“ctrl+/”就可以取消注释。

    image

    方法二:跟注释单行一样在每一行前面输入“shift+#”。对于新手小白想更轻松的学好Python基础,Python爬虫,web开发、大数据,数据分析,人工智能等技术,这里给大家分享系统教学资源,架下我尉(同英): 2763 177 065 【教程/工具/方法/解疑】

    #r+=(i-arr[idx])*rat[idx]
    #print (i-arr[idx])*rat[idx]
    #i=arr[idx]

    方法三:可以输入’’’ ‘’'或者""" “”",将要注释的代码插在中间,也可实现注释多行代码的效果。

    image

    展开全文
  • python中文解释-python注释中文

    千次阅读 2020-11-01 13:00:31
    4.python代码注释最后更新于:2019-10-05 14:25:41 python改变世界,从hello world开始 我们已经完成了第一个python程序,代码是有了,关键是好像好不知道的啥玩意?? 一.什么是代码注释代码注释就是给一段代码...
  • python中编写注释的方法

    千次阅读 2021-03-06 23:48:55
    python中编写注释的方法发布时间:2020-08-13 14:50:56来源:亿速云阅读:100作者:小新python中编写注释的方法?这个问题可能是我们日常学习或工作经常见到的。希望通过这个问题能让你收获颇深。下面是小编给大家...
  • python中如何添加注释

    千次阅读 2021-02-03 10:33:03
    python中如何添加注释发布时间:2020-09-03 09:44:46来源:亿速云阅读:79作者:小新小编给大家分享一下python中如何添加注释,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇...
  • python中注释写法

    2020-07-04 10:16:53
    怎样在python中写注释 python中的注释是以井号:#开头, 一般会#后加一个空格. 多行注释的语法是三引号: ''' 或 ""
  • 主要给大家介绍了关于Python中注释(多行注释和单行注释)用法的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用Python具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
  • python中注释代码的方法汇总

    千次阅读 2021-03-17 19:09:22
    一、python单行注释符号(#)python中单行注释采用 #开头示例:#this is a comment二、批量、多行注释符号多行注释是用三引号,例如:输入''' '''或者""" """,将要注释的代码插中间三、Windows下的IDLE的注释快捷键...
  • python作者注释

    千次阅读 2020-11-28 17:45:13
    初学python习得注释方法如下:#我是注释print(hello) 我是多行注释! 其实就是#号和三个单引号(也可以双引号)啦看下面:这注释其实是表示py文件为utf-8编码,不然默认askii码保存文件#coding=utf-8...4.python代码...
  • Python注释详解

    2020-09-21 15:46:41
    下面小编就为大家带来一篇Python注释详解。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
  • Python中的单行、多行、中文注释方法一、python单行注释符号(#)python中单行注释采用 #开头示例:#this is a comment二、批量、多行注释符号多行注释是用三引号”' ”'包含的,例如:三、python中文注释方法今天...
  • 在Python中对代码进行注释的两种方法
  • python3.6,对其配置文件的读写进行了修改,目的是设置值(会导致文件)时,对原始文件注释进行保留。由于是对原工具代码的修改,所以建议使用此文件进行覆盖之前,先对原文件进行备份,防止一些极端...
  • python全部注释

    千次阅读 2020-11-29 08:22:03
    4.python代码注释最后更新于:2019-10-05 14:25:41 python改变世界,从hello world开始 我们已经完成了第一个python程序,代码是有了,关键是好像好不知道的啥玩意?? 一.什么是代码注释代码注释就是给一段代码...
  • Python写的UDP通信程序,先绑定端口然后循环发送,可以直接运行,带中文注释,方便初学者学习和使用。
  • 在Python中注释用井号(#)标识,井号后的内容会被Python解释器忽略,但是井号有中文出现时可能会出现问题。 1、 下面的代码按道理来说应该是没有问题的,看起来也没什么问题。 2、但是当我们运行时,程序就...
  • python中单行注释以什么开头,

    千次阅读 2020-12-28 23:06:39
    详细内容学会向程序添加必要的注释,也是很重要的。注释不仅可以用来解释程序某些部分的作用和功能(用自然语言描述代码的功能),必要时,还可以将代码临时移除,是调试程序的好帮手。当然,添加注释的最大作用...
  • python中注释功能和使用详解

    千次阅读 2020-09-04 21:49:59
    python中注释常用的有两种: 单行注释 每一行前加#号,直到这行结束为止的所有内容都是注释 说明多行代码的功能时一般将注释放在代码的上一行 说明单行代码的功能时一般将注释放在代码的右侧 样例1 >>>...
  • python大段注释

    千次阅读 2020-11-28 17:37:50
    字典(dict)列表(list)可变集合(set)python中引号的作用:‘ ‘“ “ 单引号和双引号基本没区别,同样的作用; 双引号可以内嵌单引号。 三引号作为大段文字的注释python的编解码asciiunicodeutf-8python模块...
  • 1. 设置方法 设置路径: File —&... Python Script 2. 设置内容 2.1 先给出一个样例 这个样例分别涵盖时间,作者,文件名,开发工具,连接。 #!/usr/bin/env python3 # -*- coding: utf-8 -*- # @Time...
  • 如何优雅地使用Python中的代码注释

    千次阅读 2020-11-22 21:34:08
    本教程,我们将介绍编写Python注释的一些基础知识。您将学习如何优雅地编写干净、简洁的注释,以及了解何时您可能根本不需要编写任何注释。你还会学到:为什么代码注释如此重要用Python编写注释的最佳实践希望避...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 331,514
精华内容 132,605
关键字:

如何在python中写注释