Python中的相关规则：注释，参数，模块和包

注释

1. crtl+/注释，多行注释（三对单引号或双引号）：多行注释一般放在文件开头，标明整个代码⽂件做什么事, 或者其他的信息,版本号,作者

2. Ctrl Alt L(code --> reformat code)解决灰色波浪线PEP8代码规范性问题

3. 函数的文档注释

   • 函数的⽂档注释,本质就是注释, 只不过作⽤和书写位置有特定的要求

   • 作⽤: 是对函数的作⽤和使⽤⽅法进⾏说明, ⽐如有哪些参数, 返回值是什么

   • 书写位置: 在def的下⽅,使⽤三对双引号来书写

   • 查看

     1. 在函数名上,使⽤快捷键 Ctrl q 查看

     2. 在函数名上,使⽤ 快捷键 Ctrl B 跳转到函数定义的地⽅查看

     3. 在函数名上, 按住Ctrl键,点击函数名,跳转到函数定义的地⽅查看

参数

• 参数: 在函数定义的时候,在括号中写⼊变量,这个变量就称为是函数的参数.

• 形式参数(形参) 在函数调⽤的时候,可以给定义时候的形参传递具体的数据值,供其使⽤.

• 实际参数(实参) 即: 在函数调⽤的时候,会将函数的实参值传递给形参. 好处: 可以让函数更加的通⽤, 函数中的数据值不是固定的,是调⽤的时候,你传递的.

• 使⽤场景: 判断函数中数据值是不是固定不变的, 如果是变化的,就可以使⽤参数传递

• 注意点: ⽬前书写的函数, 如果存在形参,必须传递相同个数的实参.

•   	def sun_2_num(a, b):  # a, b  形参
    	c = a + b
    	 print(c)
    	 sun_2_num(10, 20)   
    	# 10, 20 实参 10 给 a,  20 给 b
    	 sun_2_num(1, 2)
    	 sun_2_num(20, 39)
    	```
  

模块

1. 模块命名：大驼峰，每个单词的⾸字⺟都⼤写,单词之间没有下划线 例如：MyName

2. 模块导入

   •   from 模块名 import 功能名  # 导⼊指定的功能
       # 使⽤ 
       功能名()
        # ⽅式⼆  多⽤于导⼊⾃⼰书写的,或者是第三⽅的模块
       # 可以使⽤快捷键 Alt 回⻋
     

   • 操作

     

   •   from random import randint
        num = randint(1, 10)
        print(num)
     

3. 模块的导⼊顺序

   1. 在导⼊模块的时候, 会先从代码所在的⽬录进⾏导⼊
   2. 如果没有找到,回去 Python 系统的⽬录查找导⼊
   3. 如果没有找到, 报错------- 注意点: 我们⾃⼰定义的代码⽂件名字 不要和你导⼊的系统的模 块⽂件名⼀样

包(package)

• 将多个模块放在⼀个⽬录中集中管理, 并在这个⽬录中创建 ⼀个 init.py ⽂件(可以什么都不写), 就是⼀个包

• 包的创建

  

• 包的导入

  

• 案例
  

数据类型

• 数据类型分类

• 得到的数据类型

  • 使⽤ input 获取的内容, 都是字符串类型,即 str

其他

_name_ 变量

• 导⼊模块的时候, 会执⾏模块中的代码

• 作⽤: 如果在导⼊模块的时候, 模块中的部分代码不想被执⾏, 可以使⽤ _name_ 来解决

• _name_ 变量,是 Python 解释器内置的变量(变量的值是⾃动维护的), 每个代码⽂件中,都有这个变量

  • 在模块中直接右键运⾏代码⽂件, _name__变量的值是’_main’

  • 如果是被导⼊运⾏代码⽂件,__name__变量的值是模块名(⽂件名)

  • 如果是被导⼊运⾏代码⽂件,__name__变量的值是模块名(⽂件名)

  • if __name__ == '__main__':
     # 在这个 if 的缩进中书写的代码,导⼊的时候不会被执⾏
    

  • 详细解释案例：
    def func1():
        num = 10  # 局部变量
        print(num)
     
     
    def func2():
        num = 20
        print(num)
     
     
    if __name__ == '__main__':
        func1()  # 10
        func2()  # 20
        func1()  # 10
    '''在Python中，if __name__ == '__main__': 是一个常见的用法，用于检查当前模块是否是作为主程序运行。
    这句代码的作用是，在当前模块被直接执行时（而不是被其他模块导入时），执行其下面的代码块。
    
    具体解释如下：
    __name__ 是一个特殊的变量，在Python中用来表示模块的名字。
    当一个模块被直接执行时，Python会将其__name__属性设置为'__main__'。
    当一个模块被导入时，__name__属性将被设置为该模块的名字（即模块文件名，不包含扩展名）。
    因此，if __name__ == '__main__': 的意思是，如果当前模块是作为主程序运行（即直接执行），
    则执行其下面的代码块，否则不执行。
    
    这样的结构通常用于编写一些测试代码，或者用于模块的功能演示。
    为当模块被导入时，你可能只想导入其中的函数或类，而不希望执行模块中的一些测试代码或初始化代码。'''
    

一些编写代码小技巧

• 定义函数（注意：PEB8代码规范：在定义函数的前后分别留两个空行）
  1. 先不使⽤函数,将多⾏代码写完
  2. 在多⾏代码的上⽅使⽤ def 起名字
  3. 使⽤ tab 键, 将多⾏代码进⾏缩进