当前位置:

首页 > 编程开发 > Python基础之注释的三种写法(单行、多行、文档注释)详解

Python基础之注释的三种写法(单行、多行、文档注释)详解

Python注释分单行(#)、多行(三引号)和文档注释,用于描述函数、类、模块功能,提升代码可读性与可维护性,便于团队协作。应遵循PEP8规范,避免过度注释、嵌套错误及记录敏感信息,并保持注释与代码同步更新。

本文目录

    在上一章,我们系统学习了Python的输入输出函数,掌握了程序与用户交互的基本方法。这一章我们来聊聊一个看似简单、但实际非常关键的基础技能——注释。

    说白了,注释就是写给开发者自己看的“代码说明书”。对于刚入门的新手来说,养成规范的注释习惯,甚至比学会某个特定语法更重要。为什么?因为代码是写给人看的,机器只是顺带执行一下。一个没有注释的代码文件,就像一个没有说明书的复杂机械,过两周你自己都可能看不懂。

    Python基础之注释的三种写法(单行、多行、文档注释)详解

    一、核心概念与背景

    1.1 什么是Python注释

    解释器在运行代码时,会完全忽略掉注释内容。换句话说,注释的存在不会对程序的执行结果产生任何影响。它们的唯一目的,就是辅助开发者理解代码逻辑。

    简单总结:注释是写给人看的,代码是写给机器跑的。

    # 注释演示示例
    ​​​​​​​print("代码会执行") # 本行注释不会执行,仅做说明

    1.2 注释的核心作用

    很多新手觉得写注释是浪费时间,但真正经历过大型项目开发的人都知道,规范的注释在关键时刻能救命。它的核心价值主要体现在这几个方面:

    • 提升可读性:快速看懂代码逻辑、功能用途,避免自己写的代码隔天就忘了是什么意思。
    • 方便后期维护:项目迭代、bug修复时,清晰注释能大幅降低理解成本。
    • 助力团队协作:团队开发中,好的注释能让同事快速读懂你的代码,协作效率翻倍。
    • 辅助代码调试:临时注释掉某些代码段来排查问题,是调试过程中最常用的技巧之一。

    1.3 注释典型应用场景

    场景类型具体应用技术要点
    新手练习标注代码功能、记录学习思路简洁易懂、贴合代码逻辑
    函数、类、核心逻辑功能说明规范统一、参数清晰、返回值明确
    临时屏蔽代码、分段测试功能快速注释、灵活启用/禁用代码
    项目文档、接口说明、功能备注标准化文档注释,适配工具生成文档

    二、Python三大注释详解

    2.1 单行注释(最常用)

    单行注释是Python中最简单、最常用的注释方式。它的语法很直观:以# 符号开头,从#开始到本行末尾的所有内容,都会被解释器忽略。

    语法格式:# 注释内容

    来看一个具体的代码示例:

    # 单行注释:定义用户姓名
    username = "Python学习者"
    
    # 单行注释:定义用户年龄
    age = 25
    
    # 输出用户信息
    print(f"用户:{username},年龄:{age}")  # 行尾注释:打印基础用户信息

    这种注释方式的核心特点很明确:

    • 仅作用于当前行,简洁灵活
    • 可以单独成行,也可以放在代码行的末尾
    • 适合标注简单逻辑、单行代码的功能说明

    2.2 多行注释(批量注释)

    当需要注释的内容比较多,比如一大段逻辑说明,或者想临时屏蔽掉一大段代码,单行注释就显得力不从心了。这时候,多行注释就派上了用场。

    Python本身没有专门的多行注释语法,通常是通过三引号(单引号或双引号均可)来实现的。

    语法格式:

    '''多行注释内容 多行注释内容 '''

    或

    """多行注释内容 多行注释内容 """

    代码示例:

    '''
    多行注释演示
    功能:计算两个数字的和
    作者:Python学习者
    时间:2026-05-30
    '''
    def add_num(a, b):
        return a + b
    
    """
    双三引号多行注释
    可用于批量屏蔽测试代码
    print("测试代码1")
    print("测试代码2")
    """
    print(add_num(10, 20))

    它的特点很明显:

    • 支持任意行数的文本注释,不需要逐行加#
    • 单三引号和双三引号功能完全一致,随意使用即可
    • 适合大段说明、代码批量屏蔽的场景

    2.3 文档注释(项目必备)

    文档注释是一种规范化的多行注释,专门用来描述函数、类或模块的功能、参数、返回值和使用方法。在企业级开发中,这几乎是硬性要求。而且很多自动化文档生成工具都能直接识别并提取文档注释,生成项目文档。

    使用规范很严格:必须放在函数、类、模块的第一行,并且使用双三引号包裹。

    先看一个基础示例——模块注释:

    """
    项目模块:基础计算模块
    功能:实现加减乘除基础运算
    作者:Python学习者
    版本:1.0
    更新时间:2026-05-30
    """
    
    print("基础计算模块加载完成")

    再来看一个进阶示例——函数文档注释,这是标准的企业写法:

    def calculate_a vg(num_list):
        """
        计算数字列表的平均值
        Args:
            num_list (list): 传入数字列表
        Returns:
            float: 返回列表平均值,空列表返回0
        """
        if not num_list:
            return 0
        return sum(num_list) / len(num_list)
    
    # 调用测试
    print(calculate_a vg([85, 90, 88]))

    最后是一个高阶示例——类文档注释:

    class Student:
        """
        学生信息管理类
        实现学生成绩添加、平均分计算功能
        """
        def __init__(self, name, age):
            """
            初始化学生信息
            Args:
                name (str): 学生姓名
                age (int): 学生年龄
            """
            self.name = name
            self.age = age
            self.grades = []
    
        def add_grade(self, grade):
            """添加学生成绩"""
            self.grades.append(grade)

    三、实操快捷键(提升编码效率)

    在日常编码中,每行都手动输入#显然太慢了。主流编辑器都提供了注释快捷键,新手务必掌握这个效率工具。

    编辑器注释快捷键功能说明
    PyCharmCtrl + /选中代码一键批量单行注释/取消注释
    VS CodeCtrl + /批量单行注释,Shift+Alt+A 多行注释
    IDLEAlt + 3/4Alt+3注释,Alt+4取消注释

    四、常见问题与避坑方案

    4.1 注释嵌套报错

    有时候会遇到这样的问题:在三引号注释内部又嵌套了三引号,程序直接报错。

    """
    外层注释
    """ 内层嵌套三引号 """
    """

    解决方案其实很简单:注释内部避免嵌套同类型的引号,或者使用转义符。最稳妥的做法是统一注释格式,不要混用。

    4.2 注释冗余、过度注释

    还有一种常见问题是“过度注释”——明明是一行非常简单的代码,非要堆砌一堆解释,反而让代码变得臃肿。

    错误写法示例:

    # 定义a变量,赋值为10
    a = 10
    # 打印a变量
    print(a)

    正确的做法是:简单代码不注释,复杂逻辑、核心算法、业务功能才需要重点注释。注释的目的是帮助理解,而不是把代码翻译成中文。

    4.3 行尾注释间距不规范

    行尾注释如果紧贴着代码,可读性会很差,而且不符合PEP8编码规范。正确的做法是:代码与注释之间至少空两个空格,再写#号开始注释。

    五、官方编码最佳实践(PEP8规范)

    5.1 注释书写规范

    • 单行注释:# 后面必须加一个空格,再书写注释内容。
    • 独立行注释:用于解释下一行或下一段代码,禁止写无意义的空注释。
    • 文档注释:函数、类、模块必须标配,参数、返回值描述要清晰。
    • 注释语言统一:项目里要么全部用中文,要么全部用英文,不要混用。

    5.2 注释使用原则

    记住两句核心口诀:简单代码不注释,复杂逻辑详注释;业务功能必注释,冗余代码不瞎注。

    5.3 安全与开发小贴士

    • 绝对不要在注释中记录密码、密钥、接口token等敏感信息,这是安全底线。
    • 迭代代码时同步更新注释,避免注释与代码逻辑不一致,反而造成误导。
    • 废弃代码直接删掉,不要单纯注释留存,以免项目变得冗余混乱。

    六、本章小结

    核心要点回顾

    • 单行注释:# 开头,适用于单行简单说明、行尾备注。
    • 多行注释:三引号实现,适用于大段说明、批量屏蔽代码。
    • 文档注释:标准化注释,适配函数、类、模块,企业开发必备。
    • 掌握编辑器快捷键,遵循PEP8注释规范,规避常见的注释误区。
    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发 Python
    相关文章 更多
    python删除一个列表里的重复元素的方法与代码示例
    python删除一个列表里的重复元素的方法与代码示例

    学习如何使用Python高效删除列表中的重复元素。本文提供5种常见方法的代码示例,涵盖保持顺序与不保持顺序的场景,适合初学者和进阶开发者参考。

    Python写接口的步骤及完整代码示例
    Python写接口的步骤及完整代码示例

    详细讲解使用Python编写Web接口的核心步骤与完整代码示例,涵盖环境准备、路由定义、数据校验、服务启动及调试测试方法。

    codex怎么读取word文档及docx文件操作教程
    codex怎么读取word文档及docx文件操作教程

    介绍如何利用编程工具读取和解析Word文档(docx格式),涵盖基础文本提取代码示例、结构化数据处理逻辑,以及处理复杂排版时的技术局限与替代方案。

    怎么在Python中调用C语言代码提升性能
    怎么在Python中调用C语言代码提升性能

    详细讲解在Python中调用C语言代码提升性能的完整实践指南,包含原理分析、编译步骤、ctypes与CFFI具体实现、性能对比及常见陷阱。

    Python与C语言的性能差异及底层原理
    Python与C语言的性能差异及底层原理

    深入解析Python与C语言在执行效率上的数量级差异,从编译机制、变量内存布局、动态类型推断到GIL锁,系统阐明底层核心原理。

    Python和C语言哪个更适合编程入门
    Python和C语言哪个更适合编程入门

    客观对比Python与C语言在心智负担、底层机制与学习反馈上的核心差异,提供清晰有据的选择标准与切实的入门学习路径。

    selenium上传文件教程本地文件路径设置方法
    selenium上传文件教程本地文件路径设置方法

    深入解析Selenium处理文件上传的技术细节,涵盖标准HTML控件的路径直接注入法与非标准控件的系统级模拟方案,提供Windows与Linux环境下的路径设置最佳实践及常见异常排查。

    大数据开发语言选型:Java对比Scala与Python的优缺点及适用场景
    大数据开发语言选型:Java对比Scala与Python的优缺点及适用场景

    针对大数据工程场景,系统对比Java、Scala与Python在执行性能、生态结合、开发效率和维护成本上的核心差异,给出清晰的架构选型依据与落地方案。

    langgraph python guide中文入门教程详解
    langgraph python guide中文入门教程详解

    本篇LangGraph Python中文入门教程详解,系统梳理StateGraph状态机定义、节点编写、边与条件路由、检查点持久化(MemorySaver)等核心机制,提供从环境安装到完整循环智能体构建的代码示例与实操指导。

    Windows 安装 Python:从官方入口到虚拟环境的可复现实践
    Windows 安装 Python:从官方入口到虚拟环境的可复现实践

    面向后端开发者,基于 Python 官方文档说明如何在 Windows 上安装 Python、创建 venv 虚拟环境及使用 pip 管理依赖。包含可复制命令、验证方法及工具选择边界,避免常见配置误区。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。