Python代码整洁之道及代码注释

代码规范

Python代码规范遵循PEP 8风格。

以下是Python代码不遵循规范的例子：

• 同时导入两个模块
• 函数参数赋值时，=两边空格
• 代码中存在;
• 函数前只空了一行

import sys, os

def complex(real, imag = 0.0):
    return magic(r = real, i = imag)
    
a = 1; b =2

可以使用第三方模块进行代码规范化，使得代码遵循规范。常见的第三方工具有autopep8, yapf等。

在PyCharm设置中，选择Tools中的External Tools, 点击右边的+号进行外部工具配置。配置如下：

python_comment1_2.png

此时，在PyCharm的工具栏上方，选择Tools --> External Tools --> autopep8，即可对上述代码进行规范化，效果如下：

import sys
import os


def complex(real, imag=0.0):
    return magic(r=real, i=imag)


a = 1
b = 2

代码注释

Python代码注释的5种常见风格：

• Plain
• Epytest
• reStructuredText
• Numpy
• Google

各种代码注释的风格如下所示。

Plain风格：

def add(a: int, b: int) -> int:
    """

    """
    c = a + b
    return c

Epytest风格：

def add(a: int, b: int) -> int:
    """
    
    @param a: 
    @param b: 
    @return: 
    """
    c = a + b
    return c

reStructuredText风格：

def add(a: int, b: int) -> int:
    """
    
    :param a: 
    :param b: 
    :return: 
    """
    c = a + b
    return c

Numpy风格：

def add(a: int, b: int) -> int:
    """
    
    Parameters
    ----------
    a
    b

    Returns
    -------

    """
    c = a + b
    return c

Google风格：

def add(a: int, b: int) -> int:
    """

    Args:
        a:
        b:

    Returns:

    """
    c = a + b
    return c

在PyCharm中设置Python代码风格如下，之后在函数中输入三个英文引号，按下Enter键，即可看到上述的代码注释。

Python代码注释

欢迎关注我的公众号NLP奇幻之旅，原创技术文章第一时间推送。

欢迎关注我的知识星球“自然语言处理奇幻之旅”，笔者正在努力构建自己的技术社区。