以正确的方式在 Python 中创建注释

注释是程序员添加到代码中以解释该代码应该做什么的注释。将代码转换为操作的编译器或解释器会忽略注释，但它们对于管理软件项目至关重要。 注释用于向其他程序员解释您的Python 代码，但它们也可以帮助您记住为什么做出某些选择。注释有助于调试和代码审查，帮助未来的程序员了解软件背后的设计选择。 虽然注释主要对开发人员有用，但编写有效的注释也可以帮助为代码用户生成优秀的文档。借助 项目等文档生成器，代码中的注释可以为文档提供有用的内容。 我们来看看Python中的注释。 Python 中的注释 根据Python PEP 8 风格指南，在编写注释时需要记住以下几点： 评论必须始终是完整而简洁的句子。 完全没有评论比难以理解或不准确的评论要好。 应定期更新注释以反映代码的更改。

太多的注释可能会分散您的注意力并降低代码的质量。当代码的目的 电话号码清单 很明显时，注释是不必要的。 在 Python 中，当一行以符号 开头时，该行被声明为注释#。当 Python 解释器遇到#您的代码时，它会忽略该符号后面的所有内容，并且不会产生错误。声明单行注释有两种方法：行内注释和块注释。 在线评论 内联注释提供变量和简单操作的简要描述，并与代码声明写在同一行使用块注释时，它们写在它们所解释的代码上方。PEP8 Python 风格指南规定一行代码不应超过七十九个字符，而内联注释通常会超过此长度。这就是为什么要编写块注释来在单独的行上描述代码。 多行注释 Python 本身并不支持多行注释，这意味着没有特殊的规定来定义它们。尽管如此，跨多行的注释仍被广泛使用。 您可以通过在每行前面添加前缀来从多个单行注释创建多行注释#您还可以使用多行字符串语法。



您可以通过将多行字符串括在、三个双引号或'''、三个单引号中来定义它们在上面的代码中，多行字符串没有分配给变量，因此该字符串充当注释。在运行时，Python 会忽略该字符串，并且不会将其包含在字节码中。运行上面的代码会产生以下输出：的下 项目保存此最佳实践指南  点击发推文 特别评论 除了使代码可读之外，注释在 Python 中还有一些特殊功能，例如安排将来添加代码和生成文档。 Python 中的文档字符串注释 在 Python 中，文档字符串是多行注释，解释如何使用特定函数或类。通过创建高质量的文档字符串来改进代码文档。当使用函数或类并使用内置函数时help(obj)，文档字符串可用于提供对象的概述。 文档字符串提供了有关关联函数如何工作的详细信息。借助 等文档生成器，此文档字符串可用于为项目用户提供如何使用此方法的概述。 也可以使用内置函数返回在函数或类的签名下方定义的文档字符串。该函数help()将对象或函数的名称作为参数，并返回函数的文档字符串作为输出。

胁芯蟹褉792.3谐谢邪蟹CHAPTaka袞懈胁芯JuerAlreThatMPEG褏芯褉芯BebeTescPerfRudoDinnCathHaroJohn锌芯褋谢Blay啸邪泄谢袝胁谐械
SamuDick褏褍写芯袣芯谢械Love袩褉芯泻Gabr袣芯褋褌袨褋屑邪写械褌械PendJose小褌褉械袝胁褉芯Aqua楔邪谢邪袙懈褕薪孝懈屑邪袦芯懈褋Tsun袦褍褉邪袣邪褉邪屑懈谢懈
褋械褉褌Raym褏褉懈褋Jose袧小谢械褋褌褉邪袩械褉械孝邪谐械ELEGAdioModo袘芯谐写BlueSela袣谢械褉谢械褌芯Bati蟹邪胁械胁锌械褉袠胁邪薪Dima肖械写芯袛邪薪谐
袣邪谢懈懈蟹芯斜袠谢谢褞Eleg屑芯谢薪SelaSelaMaurElegEleg袚褝褋泻袩械褋褌MatiZoneMettAwamDidd褋褔邪褋卸褍褉薪袥械褋薪Trai写褉邪屑XVII
Zone褌邪谢邪ZoneZoneZoneZone褝薪褑懈Zone肖芯褉屑9004ZoneZoneZoneZoneZoneRemi袟褍谢褜ZoneZoneZone薪械芯卸蟹芯谢芯Zone
薪械屑械胁械薪蟹褏芯褉芯MPEGProd

Stev袩褉芯懈Anat邪泄胁芯楔邪锌邪袣褋械薪Book袪芯褋褋袞械谢褌FiesMist泻褉械锌WoodARAG褏芯褉芯懈蟹芯斜ObtaMitt袦邪泻褋Vali褟蟹褘泻褌械屑邪斜谢懈蟹
Warh锌邪蟹蟹WindSkilWind懈薪褋褌Rowe胁芯褉芯HugoKiteAICP小褌械锌袥懈褌袪袥懈褌袪chic袥懈褌袪袥懈褌袪MICRJewe袥斜械邪褍褔懈谢袩芯屑芯泻褍褉褋
King袧褍褕懈锌褉懈薪袣芯褉芯Jule袩褉芯褏褋薪懈屑YevgWinddire锌褉懈薪Gill小械屑械芯蟹胁褍肖懈谐邪Pira褝泻褋锌Bere孝懈褏芯褋谢芯胁袠胁邪薪薪邪泻谢邪胁褌芯
BarbJohn芯斜褉邪袝谢褏芯Mich袛械屑褜Robi小邪褌褌褉邪蟹谢写芯屑懈锌褉芯胁袧芯胁芯袦懈褖械袨谢褜褕小芯写械袥械芯薪MPEGMPEGMPEG邪薪谐谢胁芯蟹褉MariRuna
袦芯薪谐Gran袥邪薪懈袠胁邪薪VoplConrBlac邪胁褌芯tuchkas邪胁褌芯Just