Pycharm学习教程（2） 代码风格

为了更好地保持python代码的可读性和规范性，我们需要学习和遵守代码风格规范。本教程将介绍Pycharm中代码风格相关的设置和使用方法，以及代码风格规范的建议。

代码风格相关设置

在Pycharm中，可以进行很多代码风格相关的设置。以下是其中一些重要的设置：

1. PEP 8代码风格检查

PEP 8是一份Python代码风格规范，建议遵守以下规则：

• 缩进使用4个空格；
• 一行的字符数不能超过79个；
• 使用不同的行来分隔函数和类，以及函数内的不同部分；
• 空行使用得当，让代码更易读；
• 将注释放到单独的一行，使代码更易读；
• 使用空格来分隔运算符和关键字。

Pycharm内置了PEP 8的检查工具，可以在代码中自动检测并指出不符合PEP 8规范的地方。

要启用PEP 8检查，可以在菜单栏中选择“File” -> “Settings” -> “Editor” -> “Inspections”，勾选“Python”，然后打开“PEP 8 coding style violation”选项。

2. 自动PEP 8代码风格调整

在Pycharm中，可以通过“Code” -> “Reformat Code”来自动进行代码风格调整，将不符合PEP 8规范的代码按照规范进行调整。

当然，自动调整也可能会改变代码的原本语义。所以，在每次进行自动调整之前，最好使用版本控制工具备份代码。

3. 代码块缩进设置

代码块缩进是Python中非常重要的一部分，建议使用4个空格进行缩进。在Pycharm中，可以通过“File” -> “Settings” -> “Editor” -> “Code Style” -> “Python”来进行设定。

代码风格规范建议

以下是一些Python代码风格规范建议：

1. 命名规范

• 变量和函数名使用小写字母，单词间以下划线分隔；
• 类名使用首字母大写的单词组成；
• 模块名使用小写字母，单词间以下划线分隔；
• 常量使用大写字母，单词间以下划线分隔。

2. 注释规范

• 在代码上方写出文件或模块的功能和作者名，以及代码的创建时间和修改记录；
• 在函数上方写出函数的功能、输入和输出参数、异常处理说明等；
• 在代码中涉及到重要的变量、函数等的使用方法注释；在冗长或复杂的逻辑中加入简短明了的注释。

示例说明

示例一

def sum(a, b):
    """
    计算两个数的和
    :param a: 第一个数字
    :param b: 第二个数字
    :return: 两个数字的和
    """
    return a + b

在这个例子中，我们使用了文档字符串来说明这个函数的功能，输入和输出的参数类型，以及返回值。这样可以让代码更加易读。

示例二

class Animal:
    def __init__(self, name, age):
        self.name = name
        self.age = age

    def eat(self, food):
        """
        动物吃食物
        :param food: 食物名称
        """
        print(self.name + "正在吃" + food)

    def sleep(self):
        """
        动物睡觉
        """
        print(self.name + "正在睡觉")


dog = Animal("小狗", 2)
dog.eat("骨头")
dog.sleep()

在这个例子中，我们定义了一个Animal类，并定义了__init__和eat、sleep方法。在方法上方，我们使用文档字符串来说明方法的功能。在代码中，我们通过类的实例来调用方法，使代码更加易读。同时，我们在类名和方法名上也遵循了命名规范。