首页 > 编程语言 >python-注释-笔记

python-注释-笔记

时间:2022-11-14 10:33:44浏览次数:60  
标签:多行 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/chen8866/5848496

相关文章

  • python-循环-笔记
    循环目标程序的三大流程while循环基本使用break和continuewhile循环嵌套01.程序的三大流程在程序开发中,一共有三种流程方式:顺序——从上向下,顺序执行代码分支——......
  • python-函数基础-笔记
    函数基础目标函数的快速体验函数的基本使用函数的参数函数的返回值函数的嵌套调用在模块中定义函数01.函数的快速体验1.1快速体验所谓函数,就是把具有独立功能的代码块组......
  • python-高级变量-笔记
    高级变量类型目标列表元组字典字符串公共方法变量高级知识点回顾Python中数据类型可以分为数字型和非数字型数字型整型(​​int​​)浮点型(​​float​​)布尔型(​​boo......
  • 学习笔记-《代码整洁之道》
    《代码整洁之道》读书笔记Part1让代码比你来时更干净编写代码的难度,取决于周边代码的阅读难度。想要快速实现需求,想要快速完成任务,想要轻松的写代码,请先让你书写的代......
  • Linux学习笔记(12)——认识系统服务(daemon)
    认识系统服务(daemon)认识系统服务(daemon)一、什么是daemon与服务(service)1.1systemd使用的unit分类二、通过systemctl管理服务2.1通过systemctl管理单一服务(serv......
  • 学习笔记-《游戏编程模式》
    《游戏编程模式》全书内容梗概总结这是一篇超过万字读书笔记,总结了《游戏编程模式》一书中所有章节与内容的知识梗概。 目录与说明《游戏编程模式》一书中总共介绍......
  • 学习笔记-《Effective C# 第二版》
    读书笔记原则1:尽可能地使用属性(property),而不是可直接访问的数据成员1.概述属性一直是C#语言的一等公民。自C#1.0版本以来,C#对属性进行了一系列的增强,让其表达能......
  • 学习笔记-《GPU 编程与CG 语言之阳春白雪下里巴人》
    第一章绪论1.1ProgrammableGraphicsProcessingUnit发展历程ProgrammableGraphicsProcessingUnit(GPU),即可编程图形处理单元,通常也称之为可编程图形硬件。GP......
  • 神币概率期望讲课笔记
    一些结论\(n\)个点的有向图从\(1\)走到\(n\)期望时间柿子就是这样子\[f_x=1+\frac{\sumf_v}{in_x}\]“每一刻事件有\(p\)概率发生,问事件发生期望时间”列出......
  • python字符串操作函数
    1.字符串基本操作:操作格式/函数名称功能参数返回值范例变量名[idx]关键词:获取单个字符获取字符串中指定索引位置的字符idx:要获取的索引位置结果是包含了单个字......