企业官网建设流程全解析

起名的规矩、不该变的值的约定写法、以及写给未来自己的说明书

5.1 标识符：起名的规矩

变量名, 后面将要学习的函数名, 类名, 这些被统称为标识符, 的命名规则乃是硬性的, 一旦违反马上就会报错:

命名规则演示

user_name = "小明" # 合法：小写+下划线（推荐风格） _user2 = "小红" # 合法：下划线开头也允许 # 2user = 1 # 报错：数字开头 # my-name = 1 # 报错：横线不在允许字符里 # class = 1 # 报错：class 是关键字

一种风格方面的建议, 并非强制要求不过在全行业当中普遍通行 （）, 指变量名要采用小写蛇形: 、。能够做到见名知义相比于字短而言更为重要）完胜 ed。一个月以后的你也会成为 “别人” , 要善待未来时段的自己。

5.2 常量：约定俗成的"别动牌"

很多语言有真正的常量（赋值后不可改）。 没有，但有约定：

常量约定

# 全大写 = 广播"我是常量，别改我" TAX_RATE = 0.13 MAX_RETRY = 3 PI = 3.14159 price = 100 print(price * TAX_RATE) # 13.0

将名字全部写成大写形式, 就如同博物馆里写着“请勿触摸”的牌子。这块牌子虽然无法阻止你伸出手去（并不阻拦你进行修改）, 然而所有知晓规矩的人都不会去触碰。在团队协作当中, 要是有人更改了全部为大写的变量, 那么在编写代码的时候就会被退回——这可是程序员之间的契约所规定的。

5.3 注释：写给未来的自己

三种注释

# 1. 单行注释：井号开头，本行后面的内容全部被忽略 # 计算含税价：价格 × (1 + 税率) total = price * (1 + TAX_RATE) # 2. 多行内容可用多个单行注释（比三个引号更常用于纯注释） # 作者: 小明 # 日期: 2026-08-24 # 功能: 演示注释 # 3. 文档字符串（docstring）：紧跟在函数/类下方的三引号说明 # 它会被 Python 收录，help() 能查到（函数课详讲） """这个文件的用途：演示三种注释写法"""

写法

用途

什么时候写

# 单行注释

解释"为什么这么写"

写巧妙/反直觉的代码时

全大写常量

标记魔法数字的含义

出现"凭什么是这个数"的时候

"""文档字符串"""

给函数/类/模块写说明书

定义函数时（函数章节）

具有两大反面情况的注释: 其一为, i = i + 1 # i加上1——属于废话注释之范畴, 代码自身已表明之事无需再度重复；其二是, 代码已然更新但注释却未曾更新——过时的注释相较没有注释来讲更具损害性。就像注释写的是“为什么”（为何要跳过前面两行）, 却没写“是什么”（这一行正在进行打印）。

何故, 不进行真正意义上的常量强制呢? 提示: 其秉持的哲学乃是“我们皆为成年人”（We are all）——语言并不对你加以阻拦, 而是寄望于约定以及自觉。此一哲学亦对后续将会遭遇的诸多“不会引发报错然而切莫如此行事”的写法作出了解释。

️ 本课练习

练习 1: 把下面这些名字进行分类, 分类为: 合法且规范, 合法但不规范, 非法 , 其中包括, user name, _temp, 2fast, for, 、。

符合法律规定并且合乎规范的是: （蛇形结构）；在法律允许范围内却不符合规范的有: （大驼峰形式用于类名）、_temp（以下划线起始具有特殊意义）、（小驼峰样式属于 Java 风格）；不合法的情况为: user name（包含空格）、2fast（以数字作为开头）、for（系关键字不可用此命名）。

将代码 0.13 直接写入计算式的程序, 进行改造, 使其成为常量版本, 并且, 给每一步骤添加带有"为什么"特质风格的注释。

总共等价于价格去乘以, （额外增加的部分被设定为）0.13, 随后总共等于价格乘以, （1加上额外增加的部分）。在半年之后接手这个事务的人看到, 立刻能够透彻理解, 看到1.13这个数值只能去猜测。

做练习 3, 特意去写 name ="小明" , 随后把这一行给注释掉, 接着再去 print(name), 留意观察报错情况。而后去体会, 注释并非仅仅是给人看的, 实际上它切实地致使代码失效了。

报注释是调试利器, 其作用巨大, 一旦怀疑某行存在问题, 可通过Ctrl+/ 的方式 将其注释掉, 查看报错是否消失, 而此方式被称为二分排查法, 在后续的调试课程中会经常被使用。

把练习 4 中的内容进行如下改写: 将练习 4 里的那种以三引号界定的, 对用以练习的文件所撰写的一段关于文件头的说明进行更改, 这段说明内容包含作者、日期和本文件练习内容, 再让其运行, 之后去确认它不会被打印出来, 还要思考它为何会被“藏”起来。

单独的三引号字符串属于“表达式语句”, 经计算后会直接被丢弃, 不会产生任何效果。唯有在紧跟def/class定义的情况下, 它才会被特殊收录为。暂时记住该现象便可, 函数课上自会知晓。