37 lines
1.6 KiB
Markdown
37 lines
1.6 KiB
Markdown
# 如何在 Python 中使用注释
|
|
|
|
> 原文：<https://www.pythonforbeginners.com/comments/comments-in-python>
|
|
|
|
当使用任何编程语言时，您都需要在代码中包含注释来表示您的工作。这详细说明了代码的某些部分的用途，并让其他开发人员——包括您——知道您编写代码时在做什么。这是一个必要的实践，好的开发者大量使用评论系统。没有它，事情会变得非常混乱，非常快。
|
|
|
|
### 如何用 Python 写注释
|
|
|
|
在 Python 中，有两种方法来注释代码。
|
|
|
|
第一种是包含注释，详细说明或指出一段代码(或代码片段)的作用。
|
|
|
|
第二种方法使用多行注释或段落，作为他人阅读您代码的文档。
|
|
|
|
把第一种想成是对自己的评论，第二种想成是对别人的评论。然而，添加评论的方式没有对错之分。你可以做任何你觉得舒服的事。
|
|
|
|
单行注释是简单地通过以散列字符(#)开始一行来创建的，它们在行尾自动终止。
|
|
|
|
例如:
|
|
|
|
```py
|
|
*#This would be a comment in Python*
|
|
```
|
|
|
|
跨越多行的注释——用于更详细地解释事情——是通过在注释的每一端添加分隔符(" ")来创建的。
|
|
|
|
```py
|
|
*"""
|
|
This would be a multiline comment*
|
|
*in Python that spans several lines and*
|
|
*describes your code, your day, or anything you want it to*
|
|
*"""*
|
|
```
|
|
|
|
**请注意:**多行注释的推荐方法是每行使用#。(" ")方法实际上不是注释，而是定义了(" ")之间文本的文本常量。它不会显示，但确实存在，可能会导致意外错误。
|
|
|
|
记得尽可能经常评论。这很重要！ |