devc中文注释显示问号_Python零基础入门-(如何让人读懂你的代码)文档注释

目标

注释的作用
单行注释（行注释）
多行注释（块注释）

01. 注释的作用

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

02. 单行注释(行注释)

以 # 开头，# 右边的所有东西都被当做说明文字，而不是真正要执行的程序，只起到辅助说明作用
示例代码如下：

# 这是第一个单行注释
print("hello python")

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

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

在程序开发时，同样可以使用 # 在代码的后面（旁边）增加说明性的文字
但是，需要注意的是，为了保证代码的可读性，注释和代码之间 至少要有 两个空格
示例代码如下：

print("hello python")  # 输出 `hello python`

03. 多行注释（块注释）

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

"""
这是一个多行注释

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

什么时候需要使用注释？

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

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

关于代码规范

Python 官方提供有一系列 PEP（Python Enhancement Proposals）文档
其中第 8 篇文档专门针对 Python 的代码格式 给出了建议，也就是俗称的 PEP 8
文档地址：https://www.python.org/dev/peps/pep-0008/
谷歌有对应的中文文档：http://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/

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

devc中文注释显示问号_Python零基础入门-(如何让人读懂你的代码)文档注释相关推荐

初学者怎样看懂python代码_Python零基础入门-(如何让人读懂你的代码)文档注释
目标注释的作用单行注释(行注释) 多行注释(块注释) 01. 注释的作用使用用自己熟悉的语言,在程序中对某些代码进行标注说明,增强程序的可读性 02. 单行注释(行注释)以 # 开头,# 右边的所有 ...
bigdecimal判断大于零_Python零基础入门（七）：运算符
点击蓝字一起划水 Review: Python零基础入门(一):对Python的简单认识 Python零基础入门(二):字符串基础 Python零基础入门(三):字符串进阶 Python零基础入门( ...
python做动画视频教程_Python零基础入门动画教程
课程答疑: QQ群:913293727 适用人群在校大学生/应届毕业生/业余编程爱好者/初.中开发学习者/大中专院校师生/数据分析人员/技术支持/测试人员课程概述--课程大纲-- 1.Python ...
python代码大全和用法用量_python零基础入门命令方式汇总大全，快速恶补你的Python基础...
原标题:python零基础入门命令方式汇总大全,快速恶补你的Python基础无意中浏览到这篇来自大牛的分享,总结的很全面,我重新排版下放在这里,希望能帮助到大家.在此十分感谢原作者! 在开始之前还是 ...
python中的变量是动态类型的什么意思_Python零基础入门（一）：对Python的简单认识...
点击蓝字关注浅韵一起划水写在前面期末考试告一段落之后,这个公众号又活了. 漫长的假期,想玩也是肯定的,但是发现自己想学的东西也很多,想写的东西也很多,所以给自己来了一个假期整活计划. 在这个假 ...
python 二进制流转图片_Python零基础入门到精通-5.1节:Python程序的执行过程
教程引言: 系统地讲解计算机基础知识,Python的基础知识, 高级知识,web开发框架,爬虫开发,数据结构与算法,nginx, 系统架构.一步步地帮助你从入门到就业. 5.1.1 在命令行中执行Py ...
python怎么输出浮点数_python 零基础入门教程第 2 章：基本数据类型 (一)
一.什么是数据类型编程语言通过一些复杂的计算机物理底层机制,创造不同类型的数据,用来表示现实世界中的不同信息,以便于计算机更好的存储和计算. 每种编程语言都会有一些基本的数据类型用来表示现实世界中的 ...
c# 字典排序_Python零基础入门之列表与字典
本篇内容需结合源码,获取方法看末尾数据结构数据结构就是指从计算机存储.组织数据的结构列表(List) 元组(Tuple) 字典(Dictionary) 集合(Set) 列表(List) 列表中的 ...
python 类和对象_Python零基础入门学习33：类与面向对象编程：类的继承
注:本文所有代码均经过Python 3.7实际运行检验,保证其严谨性. 本文字数约1300,阅读时间约为3分钟. Python面向对象编程类的继承机制如果一个类A继承自另一个类B,就把继承者类A称 ...

devc中文注释显示问号_Python零基础入门-(如何让人读懂你的代码)文档注释

目标

01. 注释的作用

02. 单行注释(行注释)

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

03. 多行注释（块注释）

什么时候需要使用注释？

关于代码规范

devc中文注释显示问号_Python零基础入门-(如何让人读懂你的代码)文档注释相关推荐

最新文章

热门文章