【Python开发手册】深入剖析Google Python开发规范：规范Python注释写作

• 💖 作者简介：大家好，我是Zeeland，全栈领域优质创作者。
• 📝 CSDN主页：Zeeland🔥
• 📣 我的博客：Zeeland
• 📚 Github主页: Undertone0809 (Zeeland) (github.com)
• 🎉 支持我：点赞👍+收藏⭐️+留言📝
• 📣 系列专栏：Python系列专栏 🍁
• 💬介绍：The mixture of software dev+Iot+ml+anything🔥

本文节选自笔者博客： https://www.blog.zeeland.cn/archives/5h192hdzx

前言

在Python编程中，注释的作用不仅仅是解释函数或代码块的作用，还可以提高可读性、可维护性和表达代码意图的清晰性。正确书写Python注释，既是程序员的编程规范，更是提高代码质量的必要措施。因此，本文总结了Python注释的写法规范和注意事项，以及如何利用Pycharm代码模板快速生成规范注释的方法，帮助广大程序员提高代码质量和效率。

Python注释写作规范

1. 用#开头，紧跟一个空格，然后是注释内容。
2. 注释应该描述清楚代码的意图，避免出现无用的信息。
3. 注释应该写在代码上方或右侧，避免在代码中间插入注释。
4. 长注释应该使用多行注释，用三个双引号或单引号将注释括起来。
5. 注释应该使用英文，并且遵循正确的语法和拼写规则。

Google Python开发规范注释示例

在Google Python Style Guide中，函数下面的注释，也称为docstring，应该遵循以下规范：

1. 函数应该在其定义之前加上注释，用以描述函数的作用和功能。

2. 函数注释应该包括以下内容：

   • 函数的输入参数和类型；
   • 函数的输出结果和类型；
   • 函数的作用和实现细节；
   • 函数的示例代码。

3. 函数注释应该遵循Google自己定义的文档字符串格式，即以"""开头和结尾，第一行是概述函数作用的简短语句，接下来是更详细的描述性文本行。

4. 对于函数参数和返回值的注释，应该使用类型提示来指定参数和返回值的类型，并在注释中提及。

docstring应该在函数定义的第一行后面紧随着出现，用三个引号围起来，格式如下：

def function_name(parameter1, parameter2):
    """
    This is a docstring. It should briefly describe the function and
    its parameters, and possibly give some examples of usage.

    Arguments:
    - parameter1: A description of the first parameter
    - parameter2: A description of the second parameter

    Returns:
    A description of the return value or None if the function doesn't return anything
    """
    # Function body here

docstring应该包括函数的描述、参数和返回值的描述：

• 函数的描述应该简洁明了，阐述函数的作用、输入和输出。
• 参数的描述应该使用文本和类型标注来标识各个参数的作用和类型。
• 返回值的描述应该明确地描绘函数返回的值，包括类型和可能的值范围。

Pycharm代码模板使用方法

如下图，在pycharm定义函数时，单/双三引号添加函数注释，pycharm会自动帮助生成注释模板。个人觉得不是很美观，用着不习惯。

经查阅，该注释模板可以自定义，也有现成的常用注释模板格式供选择。

后来发现直接选择现成注释模板更方便，比如“Google”注释模板格式。相比而言，自定义方法显得繁琐，而且个人觉得没必要花这时间。

以下是选择现成常用注释模板格式的方法：

在pycharm窗口中，依次选择：File→Setting→Tools→Python Integrated Tools→Docstrings→Docstring format: 在下拉菜单中选择“Google” 或是其他你喜欢的格式。

效果如下：

遇到的问题和解决方案

在使用Pycharm代码模板时，有时会遇到代码模板无法自动替换参数值的情况。这时，需要检查代码模板中各个参数的名称和占位符是否正确，或者检查输入参数时是否有语法或拼写错误。另外，也可以在编辑器中手动输入注释，避免使用代码模板。

结论

Python注释的规范性和准确性对于程序员来说是非常重要的，它不仅提高了代码的可读性和可维护性，而且提高了开发效率和协作能力。在编写Python代码时，我们应该遵循规范的注释书写方法，并根据自己的需要来选择合适的工具，如Pycharm代码模板，来帮助我们更快地完成代码注释。