python如何注释大段代码？注释大段代码的快捷键是什么？

我们相信：世界是美好的，你是我也是。 来玩一下解压小游戏吧！

探讨一下非常基础的python代码使用问题，如何给python代码加注释呢？这就是本文要讨论的问题。是不是非常基础？所以，本文只适合于python新手小白。

苏南大叔的“程序如此灵动”博客，记录苏南大叔的代码经验总结。本文测试环境：win10，python@3.11.0，vscode@1.83.0，pycharm@2023.2。

python代码注释方法

基于python代码，有三种注释方式。分别是：井号、三个双引号、三个单引号。

单行注释井号

python单行代码注释，就是使用井号#了。最常使用的注释方式也是这个。
在windows环境下，vscode和pycharm的单行注释功能的快捷键都是ctrl+/。

多行注释三个双引号【不支持嵌套】

python多行代码注释，有两种方式，分别是：

• 一对儿"""（三个连续的双引号）。
• 一对儿'''（三个连续的单引号）。

其实看键盘的话，单引号和双引号其实都是同一个按键。

python大段注释快捷键的话：

• vscode是shift+alt+a，是不是很奇怪？而且实际上也不好用。
• pycharm是选中代码之后，直接按三下"或者'按键，（其实是同一个按键）。
• 直接按三下"或者'按键，各种编辑器里面也是都会自动补齐的。

相比较单行注释，快捷键按下后是很智能的。但是，这个大段注释快捷键功能，注释的位置就有些尴尬了。这个说不清，大家自己体会。比如选中某行代码的一部分，单行快捷键，会把井号写在代码最前面。符合预期。如果使用多行注释的话，自动插入的三个双引号注释符，位置就会精确的包裹选中的部分。就会看到前半句代码没有被注释上的效果，略显尴尬。

特例一：在函数内使用多行注释

在函数里面使用多行注释的话，会被解析成函数的说明文档。可以使用help(func)或者func.__doc__来查看。例如：

# 单行注释
def test(name,blog):
    """
    多行注释演示，函数文档
    :param name:形参1，作者名称
    :param blog:形参2，博客名称
    :return:域名字符串
    """
    return "newsn.net"
help(test)
print("==========")
print(test.__doc__)

输出：

Help on function test in module __main__:

test(name, blog)
    :param name:形参1，作者名称
    :param blog:形参2，博客名称
    :return:域名字符串

    多行注释演示，函数文档
    :param name:形参1，作者名称
    :param blog:形参2，博客名称
    :return:域名字符串

特例二，在变量定义值里面使用注释符号

放在变量定义的等号右侧的时候，并不会被解析为注释符号。例如：

s1 = '''苏南大叔'''
s2 = """newsn.net"""
s3 = "#程序如此灵动"
print(s1,s2,s3)

输出：

苏南大叔 newsn.net #程序如此灵动

相关文章

• https://newsn.net/say/vscode-diff.html
• https://newsn.net/say/pydevd-pycharm.html

结束语

更多python相关经验文章，请点击：

• https://newsn.net/tag/python/

如果本文对您有帮助，或者节约了您的时间，欢迎打赏瓶饮料，建立下友谊关系。
本博客不欢迎：各种镜像采集行为。请尊重原创文章内容，转载请保留作者链接。