很多人刚开始学 Python,会有一种错觉。
只要代码能跑,就算学会了。
这句话只对了一半。
代码能跑,当然是第一步。 但如果你的代码自己过两天都看不懂,或者稍微一改就报错,那这种能跑,其实很脆弱。
真正好的代码,不只是能运行。 还应该清楚、整齐、容易读、方便改。
而这些能力,不是你学到很后面才需要的东西。恰恰相反,它们应该从一开始就养成。
今天这篇,我们就把三个特别基础、但又特别关键的内容讲清楚:
什么是注释 什么是缩进 什么是最基本的代码规范
你现在把这些习惯养好,后面学判断、循环、函数的时候,会轻松很多。
一、什么是注释
先说最简单的。
注释,就是写给人看的说明文字。 它不会被程序执行,但可以帮助你和别人理解代码。
比如这段代码:
name = '小明'print(name)
当然能运行。 但如果你想提醒自己,这个变量是保存用户名的,就可以加上注释:
# 保存用户姓名name = '小明'# 输出用户姓名print(name)
运行结果还是一样:
小明
说明什么。
说明注释不会影响程序结果。 它只是帮助你解释代码。
你可以把注释理解成代码旁边的小纸条。 程序不会理它,但人看了会更明白。
二、单行注释怎么写
Python 里最常见的注释方式,就是用井号,也就是 #。
写法很简单:
# 这是一条注释print('你好')
只要一行内容前面加上 #,这一行就会被当成注释。
比如:
# 这是我的第一行 Python 注释print('开始学习 Python')
你也可以把注释放在代码后面:
name = '小明'# 这是用户名age = 18# 这是年龄
这种写法也很常见。 但刚开始学的时候,我更建议你把注释单独写一行,这样更清楚,不容易看花。
三、什么时候该写注释
新手最容易走两个极端。
一个极端是完全不写。 另一个极端是每一行都写,写得比代码还多。
这两种都不太好。
注释不是越多越好。 注释真正的作用,是解释那些别人一眼不一定能看懂的地方。
比如这种很直白的代码:
name = '小明'print(name)
你再写注释:
# 定义一个变量name = '小明'# 打印变量print(name)
虽然也没错,但价值不大。因为代码本身已经很简单了。
更值得写注释的,是这些场景:
第一,说明一段代码是干什么的
# 计算商品总价price = 19.9count = 3total = price * countprint(total)
第二,提醒某个地方容易出错
# 注意:input 获取到的内容默认是字符串age = int(input('请输入年龄:'))
第三,给一大段代码加分区说明
# 用户信息输入name = input('请输入姓名:')age = int(input('请输入年龄:'))# 信息输出print(f'姓名:{name}')print(f'年龄:{age}')
你可以先记一个很实用的原则。
代码自己已经说明白的地方,不必硬写注释。 代码容易让人疑惑的地方,最好补一句。
四、不要把注释当摆设
有些人写注释,不是为了说明代码,而是为了让自己看起来很认真。
比如:
# 定义priceprice = 10# 定义countcount = 5# 定义totaltotal = price * count
这种注释,基本没有提供新信息。 因为变量名本身已经把意思写出来了。
更好的写法,是告诉读者这段代码在做什么:
# 计算购买商品的总价price = 10count = 5total = price * count
所以你以后写注释时,别只盯着代码表面。 多想一步,别人为什么需要看这句注释。
五、缩进到底是什么
接下来讲新手最容易被报错教育的一件事。
缩进。
先说最直白的理解。
缩进,就是代码前面空出来的一段位置。
比如下面这段:
ifTrue: print('你好')
你会发现第二行前面往右空了一点。 这一点空出来的位置,就是缩进。
在很多编程语言里,缩进主要是为了好看。 但在 Python 里,缩进不只是好看,它直接影响代码结构。
也就是说,在 Python 里,缩进不是装饰品。 它是语法的一部分。
六、为什么 Python 对缩进这么敏感
因为 Python 用缩进来表示代码的层级关系。
看这个例子:
age = 18if age >= 18: print('你已经成年了')
这里的意思是:
如果年龄大于等于 18, 就执行下面那行打印语句。
为什么 Python 知道 print() 是属于 if 的。
就是因为它看到了缩进。
再看这个错误例子:
age = 18if age >= 18:print('你已经成年了')
这段代码通常会报错。 因为 if 后面本来应该有一个缩进的代码块,但你没有缩进去。
所以 Python 会觉得,结构不完整。
你现在先别急着学 if 的全部语法。 今天你只需要先记住:
冒号后面,往往要跟一个缩进块。 缩进告诉 Python,哪些代码是一组的。
七、缩进到底空几个格
这是很多新手刚开始最想问的问题。
答案是,最常见、最推荐的是 4 个空格。
你自己敲代码时,不一定真的手动按 4 次空格。很多编辑器在你按 Tab 键时,会自动帮你处理成合适的缩进宽度。
比如下面这段代码:
ifTrue: print('第一行') print('第二行')
这里两行 print() 都在同一层缩进里,说明它们都属于 if 下面的内容。
你以后写判断、循环、函数时,会频繁用到这个结构。
所以现在就要养成一个习惯:
该缩进的地方,一定缩进。 同一层代码,缩进必须对齐。
八、缩进最常见的错误有哪些
这部分很实用,你后面很快就会遇到。
第一种错误,该缩进没缩进
ifTrue:print('Hello')
这种会报错。
第二种错误,不该缩进却缩进了
print('开始') print('继续')
第二行前面莫名其妙多了一段空格,也可能报错。
第三种错误,同一层代码缩进不一致
ifTrue: print('第一行') print('第二行')
第一行缩了 4 个空格,第二行却多缩了,结构就乱了。
第四种错误,空格和 Tab 混着用
有时候你眼睛看着是对齐的,但编辑器里其实一部分是空格,一部分是 Tab。 这类问题新手不太容易第一时间看出来,但会导致奇怪报错。
所以最稳妥的办法是:
尽量用同一种缩进方式 最好直接使用编辑器默认设置 不要今天手敲空格,明天乱按 Tab
九、自己动手感受一下缩进
下面你可以亲手做个练习。
先写一段正确代码:
age = 20if age >= 18: print('你已经成年') print('可以继续学习 Python')
运行一下,看看结果。
然后你故意把第二行 print() 前面的空格删掉,改成:
age = 20if age >= 18:print('你已经成年')print('可以继续学习 Python')
再运行一次。
你大概率会看到报错。 这个练习很有意义,因为它会让你亲身感受到:
缩进不是看着整齐就行 它是真的决定程序结构
十、代码规范是什么
前面讲了注释和缩进,现在说代码规范。
你可以把代码规范理解成写代码时的一些基本习惯。 它不是为了束缚你,而是为了让代码更清楚、更统一。
就像写文章要分段,写标题要有层次,写字最好别东倒西歪。 写代码也是一样。
代码规范最核心的目标就两个:
让代码更容易读 让代码更不容易出错
对新手来说,不用一上来研究特别完整的规范体系。 你先把最基础的几个习惯养起来,就已经很不错了。
十一、变量名不要乱起
这其实也属于代码规范的一部分。
来看两个对比。
第一种写法:
a = '小明'b = 18c = '北京'
第二种写法:
name = '小明'age = 18city = '北京'
哪个更清楚,一眼就能看出来。
所以变量名最好做到见名知意。 不要总是 a、b、c、x、y、z 满天飞。 除非是在特别简单、特别临时的场景下,否则尽量起清楚一点。
如果变量名由多个单词组成,推荐你这样写:
user_name = '小明'user_age = 18total_price = 99.9
全部小写,单词之间用下划线连接。 这是 Python 里很常见、也很适合新手的写法。
十二、空格也有讲究
很多新手写代码时,空格特别随意。
比如:
age=18price=10+5
当然也能跑。 但读起来会有点挤。
更推荐这样写:
age = 18price = 10 + 5
你会发现,加上适当空格以后,代码清楚很多。
所以一开始就养成这个习惯:
等号两边留空格 运算符两边留空格
这样代码会更舒服,也更接近大多数 Python 代码的常见写法。
十三、一行不要写太多事
新手有时候会觉得,把很多内容挤在一行里,好像显得很厉害。
比如:
name='小明';age=18;print(name);print(age)
这虽然可能能运行,但非常不推荐。
更好的写法是老老实实分开:
name = '小明'age = 18print(name)print(age)
代码不是越挤越高级。 代码最重要的是清楚。
你以后越往后学,越会发现,清楚比炫技重要得多。
十四、适当空行,代码会更清晰
看这两段。
第一段:
name = input('请输入姓名:')age = int(input('请输入年龄:'))city = input('请输入城市:')print('你输入的信息如下:')print(name)print(age)print(city)
第二段:
name = input('请输入姓名:')age = int(input('请输入年龄:'))city = input('请输入城市:')print('你输入的信息如下:')print(name)print(age)print(city)
是不是第二种更舒服。
原因很简单。
前面三行是输入部分。 后面几行是输出部分。 中间空一行,结构立刻清楚了。
所以以后写代码时,别把所有内容都糊成一团。 适当分组,适当空行,别人读起来会轻松很多。
十五、注释、缩进、规范,放在一起看一个例子
下面这段代码,你可以重点体会一下。
# 输入用户信息name = input('请输入你的姓名:')age = int(input('请输入你的年龄:'))# 判断是否成年if age >= 18: print(f'{name},你已经成年了') print('欢迎继续学习 Python')# 程序结束提示print('程序运行结束')
这段代码虽然很基础,但已经把今天的几个点都串起来了。
有注释 有清晰的变量名 有规范的空格 有正确的缩进 有合理的分段
这就是一个比较适合新手模仿的样子。
十六、对比一下,乱代码和清楚代码的差别
先看一个不太好的版本:
n=input('请输入姓名:')a=int(input('请输入年龄:'))if a>=18: print('你成年了') print('欢迎学习')print('结束')
它也许能跑,但问题不少。
变量名太随意 缩进不够规范 整体结构有点挤 没有任何说明 可读性不高
再看优化后的版本:
# 输入用户信息name = input('请输入姓名:')age = int(input('请输入年龄:'))# 判断是否成年if age >= 18: print('你成年了') print('欢迎学习')print('程序结束')
这两段代码功能差不多。 但第二段明显更像样,也更适合以后继续改。
你要尽快意识到一点。
写代码不是只写给电脑看。 很多时候,你也是写给未来的自己看。
十七、新手现在就该养成的 6 个小习惯
这 6 个习惯特别值得你现在开始练。
第一,代码里有明显分段时,加一行空行
第二,变量名尽量写清楚,不要总用无意义字母
第三,等号和运算符两边留空格
第四,需要代码分层时,保持缩进一致
第五,容易让人疑惑的地方,加一句有用的注释
第六,代码写完后,自己从头读一遍,看顺不顺
这几件事看起来小,但长期积累下来,差别非常大。
十八、今天一定要做的实操练习
别光看,下面这几个练习最好自己做。
练习 1,给代码加注释
把下面这段代码:
name = '小明'age = 18print(name)print(age)
改成带注释的版本,比如:
# 保存用户姓名name = '小明'# 保存用户年龄age = 18# 输出用户信息print(name)print(age)
练习 2,整理代码格式
把这段乱一点的代码:
name='小红'age=20print(name)print(age)
改成更规范的写法:
name = '小红'age = 20print(name)print(age)
练习 3,练习缩进
新建一个文件,输入:
score = 85if score >= 60: print('成绩合格') print('继续加油')
运行后再故意把缩进改乱,观察报错。
这个练习很有用。 你会更直接地理解 Python 为什么这么看重缩进。
十九、给你一个综合小练习
下面写一个稍微完整一点的小程序,你自己敲一遍。
# 输入学生信息student_name = input('请输入学生姓名:')student_score = int(input('请输入学生成绩:'))# 输出基本信息print('信息录入完成')print(f'姓名:{student_name}')print(f'成绩:{student_score}')# 判断成绩是否及格if student_score >= 60: print('结果:及格') print('继续保持')
你敲完以后,再自己动手改三个地方。
把变量名换成你自己更容易理解的名字 给不同部分再补两句注释 在输入和输出之间加空行,让结构更清楚
这个过程很重要,因为你开始不是只会抄代码,而是在练代码的整洁度。
二十、写在最后
很多新手刚开始学 Python,会更关注能不能做出功能。 这当然没错。
但你也要明白,真正拉开差距的,往往不是谁会得更多,而是谁从一开始就养成了更好的写代码习惯。
注释让代码更容易理解。 缩进让代码结构更清晰。 规范让代码看起来更像样,也更不容易乱。
这些东西今天看起来好像没那么刺激,不像输入输出那样立刻能互动。 可它们的价值,会在你后面写越来越多代码时,一点点体现出来。
所以从现在开始,不要只追求代码能跑。 也开始追求代码写得清楚一点、整齐一点、像样一点。
这会让你后面的学习轻松很多。
本文小结
注释是写给人看的说明,不会被程序执行。 单行注释用 # 开头。 缩进在 Python 里不是装饰,而是语法的一部分。 同一层代码的缩进必须一致。 变量名、空格、空行、代码分段,这些都属于基本代码规范。 从一开始养成好习惯,比后面返工轻松得多。
下篇预告
第 9 篇,我们来讲一个新手几乎一定会遇到的话题。
报错并不可怕:新手必须认识的常见错误
因为真正开始写代码以后,你不可能不报错。 学会看错误、改错误,才算真正开始入门。