首页 > 其他分享 >注释

注释

时间:2023-11-09 17:03:57浏览次数:26  
标签:多行 python 代码 注释 Python hello


目标

  • 注释的作用
  • 单行注释(行注释)
  • 多行注释(块注释)

01. 注释的作用

使用用自己熟悉的语言,在程序中对某些代码进行标注说明,增强程序的可读性


02. 单行注释(行注释)

  • # 开头,# 右边的所有东西都被当做说明文字,而不是真正要执行的程序,只起到辅助说明作用
  • 示例代码如下:
# 这是第一个单行注释
print("hello python")

为了保证代码的可读性,# 后面建议先添加一个空格,然后再编写相应的说明文字

在代码后面增加的单行注释

  • 在程序开发时,同样可以使用 # 在代码的后面(旁边)增加说明性的文字
  • 但是,需要注意的是,为了保证代码的可读性注释和代码之间 至少要有 两个空格
  • 示例代码如下:
print("hello python")  # 输出 `hello python`

03. 多行注释(块注释)

  • 如果希望编写的 注释信息很多,一行无法显示,就可以使用多行注释
  • 要在 Python 程序中使用多行注释,可以用 一对 连续的 三个 引号(单引号和双引号都可以)
  • 示例代码如下:
"""
这是一个多行注释

在多行注释之间,可以写很多很多的内容……
""" 
print("hello python")

什么时候需要使用注释?

  1. 注释不是越多越好,对于一目了然的代码,不需要添加注释
  2. 对于 复杂的操作,应该在操作开始前写上若干行注释
  3. 对于 不是一目了然的代码,应在其行尾添加注释(为了提高可读性,注释应该至少离开代码 2 个空格)
  4. 绝不要描述代码,假设阅读代码的人比你更懂 Python,他只是不知道你的代码要做什么

在一些正规的开发团队,通常会有 代码审核 的惯例,就是一个团队中彼此阅读对方的代码

关于代码规范

任何语言的程序员,编写出符合规范的代码,是开始程序生涯的第一步


标签:多行,python,代码,注释,Python,hello
From: https://blog.51cto.com/u_16276558/8284687

相关文章

  • 秦疆的Java课程笔记:21 基础 注释
    平时写代码,代码量比较少的时候还能看懂自己写的,但当项目结构复杂起来,就需要用到注释。注释并不会被执行,是写给写代码的人看的,让别人更容易理解代码。注释是一个非常好的习惯。单行注释publicclassHelloWold{publicstaticvoidmain(String[]args){......
  • Java 注释
    单行注释://多行注释:/**/文档注释:/**回车设置单行注释多行注释文档注释的颜色:File→Settings→ColorScheme→Java→Cmomentslinecomment单行注释blockcomment注释区块(多行注释) JavaDoc文档注释 ......
  • Linux Vim批量注释和自定义注释
    使用Vim编辑Shell脚本,在进行调试时,需要进行多行的注释,每次都要先切换到输入模式,在行首输入注释符"#"再退回命令模式,非常麻烦。连续行的注释其实可以用替换命令来完成。换句话说,在指定范围行加"#"注释,可以使用":起始行,终止行s/^/#/g",例如::1,10s/^/#/g表示在第1~10行行首加"#......
  • eclipse中maven依赖的jar源码中文注释乱码解决
    通过maven下载源代码,在eclipse中浏览源代码时,发现中文注释为乱码的问题。eclipse默认编码造成的问题。可以通过以下方法解决:1.修改Eclipse中文本文件的默认编码:windows->Preferences->general->Workspace->Textfileencoding设置为UTF-82.修改JAVA源文件的默认编码:windows->P......
  • Python如何写注释?
    python如何写给函数写注释:样板:defread_baseline(self,sheet='internal',category='ipe_flip',):"""功能:-从baseline的Excel文件中读取数据。参数:-sheet:要读取的sheet名称,默认为internal-catego......
  • QT删除python中的单行注释
    python中的#号可能存在于字符串中:print("'asd#f'00#0",'#1“23') #这里才开始注释没想到用什么正则来删除python中的单行注释所以解决方案为:QStringremoveLineComment(QStringsLine){qDebug()<<"removeLineComment:"<<sLine;QStringsRes......
  • Oracle修改表注释的SQL语句
    要修改Oracle表的注释,可以使用COMMENTONTABLE语句。下面是修改表注释的SQL语法:COMMENTONTABLEtable_nameIS'new_table_comment';其中,table_name是要修改注释的表名,new_table_comment是新的表注释。以下是一个具体的示例:COMMENTONTABLEemployeesIS'Thistables......
  • 无涯教程-批处理 - 脚本注释
    为创建的脚本添加注释或文档始终是一个好习惯,这是维护脚本以了解脚本实际功能所必需的。如,考虑下面没有注释形式的代码,如果没有编写以下脚本的普通人试图理解该脚本,则该人将花费大量时间来理解该脚本的实际作用。ECHOOFFIFNOT"%OS%"=="Windows_NT"GOTOSyntaxECHO.%*|......
  • java基础学习:注解注释
     编译之后的注释是没有的,.class文件里没有注释的  ......
  • Git常规提交注释规范定义
    Git常规提交注释规范定义总结ConventionalCommits规范是建立在提交消息之上的轻量级约定。它提供了一组简单的规则,用于创建显式提交历史记录;这使得在它上面编写自动化工具变得更加容易。此约定与SemVer相吻合,通过描述提交消息中的功能、修复和重大更改。提交消息的结......