Merge pull request #18 from cwiki-us-docs/naming_rules

Python 命名规则代码
This commit is contained in:
YuCheng Hu 2021-03-09 10:29:33 -05:00 committed by GitHub
commit 24a05cbb43
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 129 additions and 2 deletions

View File

@ -1,2 +1,105 @@
# 命名规则
Python 命名规则
# 命名规范
在编程的时候通常会遵守一些特定的规则,其实并不是你非要换个命名方法就不可以,在这里主要就是为了大家都能够方便。
比如说大家都能够遵守相同命名规范的话,那么能够降低沟通成本,提高语言的使用效率。
Python 的命名规范被定义在 [PEP 8 Style Guide for Python Code](https://www.python.org/dev/peps/pep-0008/) 中,这个文档中的内容比较多,建议初学者都能够有时间多了解下。
我们在这里针对 Python 和其他语言的对比来选出些重要的内容。
## 大小写敏感
Python 是大小写敏感。
大小写是否敏感决定了关于变量的定义,如果大小写敏感的话,定义变量 var 和 Var 是不同的。
## 注释
Python中的注释有单行注释和多行注释。
Python 是使用 # 来进行注释的。这个等于是我们在 Java 中使用的 // 符号。
请考察下面的代码
```
print("Hello, CWIKIUS!") # Python 行内注释
# Python 单行注释
print("Hello, CWIKIUS!")
# Python 多行注释 - LINE 1
# Python 多行注释 - LINE 2
print("Hello, CWIKIUS!")
'''
Python 多行注释块 - LINE 1
Python 多行注释块 - LINE 2
'''
print("Hello, CWIKIUS!")
"""
Python 多行注释块 - LINE 1
Python 多行注释块 - LINE 2
"""
print("Hello, CWIKIUS!")
```
如果你使用 IDE读取上面的代码的话IDE 会帮你使用不同的颜色来进行表示。
![python-commont-01|690x325](https://cdn.ossez.com/discourse-uploads/optimized/2X/d/de523ad593fb10bf75ae9c18c50548375640bc2b_2_690x325.png)
如上图显示的在 IDE 中使用颜色的表示。
### 行内注释
正常来说,对于行内注释,你可以直接在代码后面添加 # 符号后再添加注释内容,这种注释方法是行内注释。
### 块注释
如果你的注释是另起一行的话,那么表示的注释为单行或者多行注释。
### 单双引号
在上面的代码上,我们可以看到你还可以使用单引号和双引号来标记为注释。
因为 Python 将会忽略任何没有指派变量的文字,因此你可以使用添加单引号和双引号的方法来标记注释,如上面的代码所显示的那样。
Python 解释器针对上面的代码将会先读进解释器但是因为没有指派变量或者值Python 将会忽略掉上面的代码,这个就是为什么你可以使用单引号或者双引号来进行注释的原因。
从 IDE 的界面你可以看到,正常 Python 的注释是灰色的如果你使用了单引号和双引号的注释IDE 上面并没有为你标记为灰色,这是因为这部分的内容还是会被 Python 解释器读取的。
所以可以根据你的实际需要选择不同的注释方式,不管使用 # 号还是引号都是没有问题的。
### 不是注释
下面的内容不是注释。
有时候你将会在 Python 代码的开头的第一行看到下面的内容:
```
#!/usr/bin/python3
```
上面的代码表示的是这个脚本使用的是 Python 3 解释器的脚本。
这是脚本语言需要共同遵守的规则:当第一行为 #!/path/to/script/interpreter 时,指定了用来执行本脚本的解释器。
使用这个需要注意下面的内容一些内容:
1. 必须是文件的第 1 行
2. 必须以 **#!** 开头。正是因为这个,会容易让人以为这个语句是 Python 的注释。
3. */path/to/script/interpreter* 是脚本解释器的全路径名。
```
# -*- coding: utf-8 -*-
```
上面的代码也是在 Python 程序的开头第 1 行后面,如果第 1 行指定了解释器的路径的话,那指定代码的编码的代码就在第 2 行。
上面用于指定代码使用 UTF-8 编码,通常是需要的。
在一般的 Python 程序中,你可能会看到:
```
#!/usr/bin/python3
# -*- coding: utf-8 -*-
```
上的内容,然后才是 Python 的代码,上面的内容表示的是当前 Python 使用的编译器版本和 Python 代码使用的字符集。
可以说上面 2 行通常都会有,或者只有一行,或者根本就没有。
我们在这里列出来主要是为了避免与注释的混淆。

24
tests/Comments.py Normal file
View File

@ -0,0 +1,24 @@
# Python Comments Example
# Author - https://www.ossez.com
print("Hello, CWIKIUS!") # Python 行内注释
# Python 单行注释
print("Hello, CWIKIUS!")
# Python 多行注释 - LINE 1
# Python 多行注释 - LINE 2
print("Hello, CWIKIUS!")
'''
Python 多行注释块 - LINE 1
Python 多行注释块 - LINE 2
'''
print("Hello, CWIKIUS!")
"""
Python 多行注释块 - LINE 1
Python 多行注释块 - LINE 2
"""
print("Hello, CWIKIUS!")