dev多行注释_Python代码注释的用法和意义
01. 注释的作用
在大多数编程语言中,注释都是一项很有用的功能。在一些简单的程序中只包含Python代码,但随着程序越来越大、越来越复杂,就应在其中添加说明,对你解决问题的方法进行大致的阐述。注释让你能够使用熟悉的自然语言在程序中添加说明,增强程序的可读性。
以下截图是一份python游戏的代码,仔细观察没有一个中文字,如果这份代码相当复杂,阅读就会变得很困难。
在开发项目期间,你对各个部分如何协同工作了如指掌,但过段时间后,有些细节你可能不记得了。当然,你总是可以通过研究代码来确定各个部分的工作原理,但通过编写注释,以清晰的自然语言对解决方案进行概述,可节省很多时间。
02. 单行注释(行注释)
以 #
开头,#
后面的内容都会被Python解释器忽略,全部被当做说明文字,而不是真正要执行的程序,只起到辅助说明作用。
# 这是第一个单行注释
print("hello python")
- 为了保证代码的可读性,
#
后面建议先添加一个空格,然后再编写相应的说明文字。 - 一般都是在代码的上方写注释。
- 如果代码和注释都很短的情况下,同样可以使用
#
在代码的后面(旁边)增加说明性的文字。需要注意的是,为了保证代码的可读性,注释和代码之间 至少要有 两个空格。 - 示例代码如下:
print("hello python") # 输出 `hello python`
03. 多行注释(块注释)
如果希望编写的 注释信息很多,一行无法显示,就可以使用多行注释。
要在 Python 程序中使用多行注释,可以用 一对 连续的 三个 引号(单引号和双引号都可以)。
示例代码如下:
"""
这是一个多行注释在多行注释之间,可以写很多很多的内容……
"""
print("hello python")
什么时候需要使用注释?
- 注释不是越多越好,对于一目了然的代码,不需要添加注释。
- 对于复杂的操作,应该在操作开始前写上若干行注释。
- 对于不是一目了然的代码,应在其行尾添加注释(为了提高可读性,注释应该至少离开代码 2 个空格)。
- 绝不要描述代码,假设阅读代码的人比你更懂Python,他只是不知道你的代码要做什么。编写注释的主要目的是阐述代码要做什么,以及是如何做的。
要成为专业程序员或与其他程序员合作,就必须编写有意义的注释。当前,大多数软件都是合作编写的,编写者可能是同一家公司的多名员工,也可能是众多致力于同一个开源项目的人员。训练有素的程序员都希望代码中包含注释,因此你最好从现在开始就在程序中添加描述性注释。作为新手,最值得养成的习惯之一是,在代码中编写清晰、简洁的注释。
如果不确定是否要编写注释,就问问自己,找到合理的解决方案前,是否考虑了多个解决方案。如果答案是肯定的,就编写注释对你的解决方案进行说明吧。相比回过头去再添加注释,删除多余的注释要容易得多。
关于代码规范
虽然还没有开始写代码,但是可以收藏起来,时不时看一下,养成规范的代码格式,越早越好。
- Python官方提供有一系列 PEP(Python Enhancement Proposals) 文档
- 其中第 8 篇文档专门针对Python的代码格式给出了建议,也就是俗称的PEP8
- 文档地址:https://www.python.org/dev/peps/pep-0008/
- 谷歌有对应的中文文档:http://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/
任何语言的程序员,编写出符合规范的代码,是开始程序生涯的第一步
dev多行注释_Python代码注释的用法和意义相关推荐
- python使用什么注释语句和运算-Python代码注释的用法和意义
01. 注释的作用 在大多数编程语言中,注释都是一项很有用的功能.在一些简单的程序中只包含Python代码,但随着程序越来越大.越来越复杂,就应在其中添加说明,对你解决问题的方法进行大致的阐述.注释让 ...
- python如何注释一段代码_python如何注释
广告关闭 腾讯云11.11云上盛惠 ,精选热门产品助力上云,云服务器首年88元起,买的越多返的越多,最高返5000元! 我是多行注释1 我是多行注释2 我是多行注释3print(我上面的是多行注释)内 ...
- 【Python基础学习笔记day05】pycharm注释的作用+单行注释(行注释)+多行注释(块注释)+关于代码规范
注释 文章目录 注释 目标 01. 注释的作用 02. 单行注释(行注释) 在代码后面增加的单行注释 03. 多行注释(块注释) 什么时候需要使用注释? 关于代码规范 目标 注释的作用 单行注释(行注 ...
- python乘法表代码注释_Python统计python文件中代码,注释及空白对应的行数示例【测试可用】...
本文实例讲述了Python实现统计python文件中代码,注释及空白对应的行数.分享给大家供大家参考,具体如下: 其实代码和空白行很好统计,难点是注释行 python中的注释分为以#开头的单行注释 或 ...
- python整段代码注释-Python中注释(多行注释和单行注释)的用法实例
Python中注释(多行注释和单行注释)的用法实例 发布时间:2020-09-30 23:18:32 来源:脚本之家 阅读:97 前言 学会向程序中添加必要的注释,也是很重要的.注释不仅可以用来解释程 ...
- php整段代码注释,PHP标准注释|单行注释|多行注释|规则方式
任何一门编程语言都有编程注释,注释的作用可以调试,可以描述代码的作用等等,说说那么PHP三种注释的方式 1, // 这是单行注释 2,# 这也是单行注释 3,/* */多行注释块 /* 这是多行注释块 ...
- python整段注释_python段注释
广告关闭 腾讯云11.11云上盛惠 ,精选热门产品助力上云,云服务器首年88元起,买的越多返的越多,最高返5000元! 初学python习得注释方法如下:#我是注释print(hello) 我是多行注 ...
- c++ doxygen 注释规范_C语言代码注释参考
简述 该参考是基于Doxygen注释规范进行简单归纳,可以适当根据自己的需求进行约定. Doxygen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX.RTF参考手册.简单 ...
- 状态机编程思想:删除代码注释(支持C/C++和Java)
前言 有时为了信息保密或是单纯阅读代码,我们需要删除注释. 之前考虑过正则表达式,但是感觉实现起来相当麻烦.而状态机可以把多种情况归为一类状态再行分解,大大简化问题.本文就是基于状态机实现的. 删除C ...
最新文章
- 比尔盖茨27年婚姻破裂,8000亿财产咋分配?
- 使用内联函数的一个问题
- 多媒体文件格式之RMVB
- syslog源码_Gunicorn源码分析01--目录结构
- 一文解开java中字符串编码的小秘密
- 05-Java通过Executors提供四种线程池
- PCL——从PCD文件中读取点云数据
- nyoj - 168房间安排
- c#明华rf读卡器_明华URF-R330读卡器C#代码示例
- 计算机教室电气设计规范,车库电气设计规范.docx
- Dvbbs 更换论坛置顶图片
- 算法提高 字符串跳步
- 计算机系统时钟中断,什么是时钟中断时钟中断的举例
- linux shell 宏定义_一篇教会你写90%的shell脚本
- 手机接收短信验证码生成(纯数字)
- [LBS学习笔记4]地理特征POI、AOI、路径轨迹
- 【专题5: 硬件设计】 之 【9.案例一:门控开关,制作BOM表和成本核算】
- 创新发明与专利实务的尔雅答案
- [论文笔记]EMNLP2019: Fine-Grained Entity Typing via Hierarchical Multi Graph Convolutional Networks
- 2023,开启「线控转向」元年