最近看了《python工匠》这本关于python的书,虽然只看了第一章关于变量与注释的内容,也有些突如其来的想法。
一直学习如何使用python 去做一些功能,忽略了它本身的一些特性和习惯。
读完了第一章,写下笔记记录下,方便日后也好查阅。
变量名
对于变量的定义从使用角度很简单,但不方便其他人,自己看可能很容,别人阅读会一脸茫然。
所以需要统一规范,方便大家都理解规则,知道这是什么。
1、变量使用小写字母,多个单词使用下划线_隔开:user_id
2、变量名尽量使用英文单词拼接,可方便阅读内容
3、内部使用变量需要在变量名前使用使用下划线:_user
4、全局变量使用全大写字母表示
5、变量名遵循PEP 8原则
6、变量名单词不宜使用太多,尽量简短
注释
注释写好看来也不是一件容易的事情,如何才能让没了解过的人,看到注释就明白呢?
不想大幅度写注释内容,言简意赅又如何做到呢?
1、写明方法的入参类型和场景
2、使用此方法的场景(不清楚这个要不要写)
3、适当的使用空行,也会达到注释或者简明的效果
命名规则
1、类名使用大驼峰命名规则
2、方法名使用蛇形命名规则
注意事项
1、方法参数尽量书写类型
from typing import List,Dict
def Numer(num: List[int])
pass
2、定义变量尽量与使用方式结合,不需要把定义变量都写在一起
3、尽量减少变量的引用
4、代码组织结构要清晰