中编写注释的最佳实践

在上面的示例中可以调用它来显示与该函数关联的文档字符串。如果您使用 flag 在交互式 shell 中运行上面的代码-i，您可以看到 Python 将如何解析该文档字符串。通过键入 运行前面的代码。 屏幕截图：在终端中解析的 Python 文档字符串注释。 在 文档字符串注释。 函数调用返回函数的文档字符串。输出包含这是 Python 自动添加的函数签名。 该属性_还可以用于以编程方式检索和修改文档字符串。在上一个示例中添加“一些其他新信息”后，它出现在第二次调用h是，您不太可能需要以这种方式在运行时动态修改文档字符串。 评论待办事项 编写代码时，有时您会想要突出显示某些行或整个块以进行改进。这些任务由 TODO 注释标记。

当您计划更新或更改代码时，或者如果您想通知用户或项目协 电话号码清单 作者仍需要编写文件代码的特定部分时，TODO 注释非常有用。 TODO 注释不应该写成伪代码：它们应该只简要解释尚未编写的代码的功能。 注释的方式与块注释没有任何不同。 在 撰写评论时需要遵循一组最佳实践，以确保可靠性和质量。以下是使用 Python 编写高质量注释的一些技巧。 避免明显的评论 那些明显的注释不会给你的代码带来任何价值，应该避免。例该注释没有帮助，因为它只是说明了代码的作用，而没有解释原因。注释应该解释他们所描述的代码的“原因”而不是“内容”。 重写后更有帮助，上面的示例可能如下所示注释应该简短 注释应该简短且易于理解。



我们将从概念到实施。 阅读时间 阅读时间电子商务 搜索引擎优化 数字营销 现场表现 评论 发表评论 发表评论 评论政策：我们喜欢评论，并感谢人们花时间分享他们的想法和意见。但是，我们会手动审核所有评论，并删除那些我们认为是垃圾邮件或纯粹促销的评论。 评论 名 电子邮件 提交此表格：您同意根据Kinsta 的隐私政策处理提交的个人数据，包括将数据传输到美国。 您还同意接收来自 的有关我们的服务、活动和促销的信息。您可以按照收到的通信中包含的说明随时取消订阅。 G2领袖奖G2 最简单管理奖中端市场的最大用户采用率中端市场的高性能G2 用户喜爱我们奖 注册我们的时事通讯 掌握 Web 开发、框架和最新语言的最新趋势。