如何在Python-3中编写注释

如何在Python 3中编写注释

如何在Python 3中编写注释

  注释是计算机程序中存在的、被编译器和解释器忽略的行。在程序中使用注释可以使代码对人类来说更具可读性,因为它提供了有关程序每个部分正在做什么的一些信息或解释。

  根据程序的目的,注释可以作为自己的注释或提醒,也可以为了其他程序员能够理解您的代码在做什么而编写。一般来说,在编写或更新程序时写注释是一个好主意,因为稍后很容易忘记您的思维过程,并且从长远来看,稍后写的注释可能不太有用。本文晓得博客为你介绍如何在Python 3中编写注释。

  推荐:如何在MacOS上将Python3设置为默认python版本

先决条件

  您应该在计算机或服务器上安装 Python 3 并设置编程环境。如果您还没有设置编程环境,您可以参考本地编程环境或服务器上适合您的操作系统(Ubuntu、CentOS、Debian等)的编程环境的安装和设置指南。

  Python 中的注释以井号 ( #) 和空格字符开始,一直到行尾。

  信息:要按照本教程中的示例代码进行操作,请通过运行命令在本地系统上打开 Python 交互式 shell python3。然后,您可以通过在提示后添加示例来复制、粘贴或编辑示例>>>。

  一般来说,评论会是这样的:

# This is a comment

  由于注释不会执行,因此当您运行程序时,您将看不到任何注释指示。源代码中的注释是供人类阅读的,而不是供计算机执行的。

  在“你好,世界!”中 程序中,注释可能如下所示:

# Print “Hello, World!” to console
print("Hello, World!")

  在迭代list的for循环中,注释可能如下所示:

# Define sharks variable as a list of strings
sharks = ['hammerhead', 'great white', 'dogfish', 'frilled', 'bullhead', 'requiem']

# For loop that iterates over sharks list and prints each string item
for shark in sharks:
   print(shark)

  注释的缩进级别应与其所注释的代码相同。也就是说,没有缩进的函数定义将具有没有缩进的注释,并且后面的每个缩进级别都将具有与其正在注释的代码对齐的注释。

如何在Python 3中编写注释
如何在Python 3中编写注释

  例如,以下是如何对如何在 Python 3 中制作简单计算器程序教程中的again()函数进行注释,注释位于代码的每个缩进级别之后:

...
# Define again() function to ask user if they want to use the calculator again
def again():

    # Take input from user
    calc_again = input('''
Do you want to calculate again?
Please type Y for YES or N for NO.
''')

    # If user types Y, run the calculate() function
    if calc_again == 'Y':
        calculate()

    # If user types N, say good-bye to the user and end the program
    elif calc_again == 'N':
        print('See you later.')

    # If user types another key, run the function again
    else:
        again()

  注释的目的是帮助程序员,无论是原始程序员还是使用或协作该项目的其他人。如果注释不能与代码库一起得到正确的维护和更新,最好不要包含注释,而不是编写与代码相矛盾或将相矛盾的注释。在注释代码时,您应该寻求回答代码背后的“原因”,而不是“内容”或“如何”。除非代码特别棘手,否则查看代码通常可以看出代码在做什么或如何做。

  推荐:Python最佳IDE集成开发环境

阻止评论

  块注释可用于解释更复杂的代码或您不希望读者熟悉的代码。这些较长形式的注释适用于后面的部分或全部代码,并且也与代码处于同一级别缩进。在块注释中,每行以哈希标记和一个空格开头。如果您需要使用多个段落,则应使用包含单个井号标记的行将它们分隔开。

  下面是块注释的示例,它定义了main()以下定义的函数中发生的情况:

# The main function will parse arguments via the parser variable.  These
# arguments will be defined by the user on the console.  This will pass
# the word argument the user wants to parse along with the filename the
# user wants to use, and also provide help text if the user does not
# correctly pass the arguments.

def main():
  parser = argparse.ArgumentParser()
  parser.add_argument(
      "word",
      help="the word to be searched for in the text file."
  )
  parser.add_argument(
      "filename",
      help="the path to the text file to be searched through"
  )
...

  当操作不太容易理解并因此需要彻底解释时,通常使用块注释。您应该尽量避免过度注释代码,并且应该倾向于相信其他程序员能够理解 Python,除非您是为特定受众编写的。

  推荐:如何使用Python抓取视频

内嵌评论

  内联注释出现在语句的同一行,位于代码本身之后。与其他注释一样,它们以井号标记和单个空白字符开头。

  一般来说,内嵌注释看起来像这样:

[code] # Inline comment about the code

  应谨慎使用内联注释,但可以有效地解释代码中棘手或复杂的部分。如果您认为您可能不记得将来编写的一行代码,或者您正在与您知道可能不熟悉代码的所有方面的人合作,它们也可能很有用。

  例如,如果您在 Python 程序中没有使用大量数学,您或您的协作者可能不知道以下内容创建了一个复数,因此您可能需要包含对此的内联注释:

z = 2.5 + 3j # Create a complex number

  内联注释也可以用来解释做某事背后的原因,或者一些额外的信息,如下所示:

x = 8 # Initialize x with an arbitrary number

  仅在必要时并且可以为阅读程序的人提供有用的指导时才应使用行内注释。

  推荐:如何使用Python获取今天的日期和时间

注释掉测试代码

  除了使用注释作为记录代码的一种方式之外,哈希标记还可以用于注释掉在测试或调试当前正在创建的程序时不想执行的代码。也就是说,当您在实现新的代码行后遇到错误时,您可能需要注释掉其中的一些错误,看看是否可以解决确切的问题。

  使用哈希标记还可以让您在确定如何设置代码时尝试替代方案。例如,您可能正在决定在 Python 游戏中使用while循环还是for循环,并且可以在测试和确定哪一个最好时注释掉其中一个:

import random

number = random.randint(1, 25)

# number_of_guesses = 0

for i in range(5):
# while number_of_guesses < 5:
    print('Guess a number between 1 and 25:')
    guess = input()
    guess = int(guess)

    # number_of_guesses = number_of_guesses + 1

    if guess < number:
        print('Your guess is too low')

    if guess > number:
        print('Your guess is too high')

    if guess == number:
        break

if guess == number:
    print('You guessed the number!')

else:
    print('You did not guess the number. The number was ' + str(number))

  使用哈希标记注释掉代码可以让您尝试不同的编程方法,并通过系统地注释和运行程序的某些部分来帮助您找到错误根源。

  推荐:如何使用Python获取IP地址信息

总结

  以上是晓得博客为你介绍的如何在Python 3中编写注释的全部内容,在 Python 程序中使用注释有助于提高程序对人类(包括未来的你)的可读性。包含相关且有用的适当注释可以让其他人更好地与您在编程项目上进行协作,并使您的代码的价值更加清晰。

  推荐:[最新版]WPCode Pro插件WordPress自定义代码插件

  推荐:python 3教程

给文章评分

晓得博客,版权所有丨如未注明,均为原创
晓得博客 » 如何在Python 3中编写注释

转载请保留链接:https://www.pythonthree.com/how-to-write-comments-in-python-3/

Claude、Netflix、Midjourney、Chatgpt Plus账号购买,ChatGPT API购买,优惠码XDBK,用户购买的时候输入优惠码可以打95折

Chatgpt-Plus注册购买共享账号
Kinsta-free-hosting主机
Kinsta-free-hosting主机
Elementor可视化创建WordPress网站
Elementor可视化创建WordPress网站
滚动至顶部