4.注释

评论

您好，欢迎来到 GDScript 基础教程系列。
在这一集中，我回顾了 Godot GDScript 中的评论。

什么是评论？

注释是计算机编程中计算机程序源代码中程序员可读的解释或注释。
添加它们是为了使源代码更易于人类理解，并且通常在运行时被编译器和解释器忽略。

如何在 GDScript 中写注释

您可以使用#符号后跟评论文本。
您可以使用三引号来打开和关闭您的评论”””。请记住，编译器会将其解释为多行字符串值。

# This is a single line comment
"""
This is a multiline comment.
This is a multiline comment.
This is a multiline comment.
"""

评论类型

您可能会发现自己使用 4 种不同类型的评论：

• 方法描述
• 元数据
• 调试
• 代码说明

  方法描述

  方法注释可用于解释您正在使用的代码，而不是澄清其意图。
  例如，在您的排序算法代码中，您可以使用方法注释来解释为什么使用插入排序算法而不是快速排序。

  """
  Quicksort turned out to be slower than insertion sort for our list. For this reason, I went with insertion sort.
  """

  元数据

  这些注释位于脚本文件的顶部。
  它们将包括公司名称、作者、文件名等内容。
  您通常会在开源代码中看到此类评论。 ```swift “”” This file is part of: Godot Game Engine https://godotengine.org

Copyright (c) 2007 -2021 Juan Linietsky, Ariel Manzur “””

<a name="QlICU"></a>
### 调试
当您想在代码上应用蛮力调试技术时，可以使用调试注释。<br />一个示例是注释掉打印语句（将内容打印到控制台）。
```swift
if(x < 10):
    # print(x)
    x = x + 1

代码说明

一般用于 o 让别人理解一行代码的意图。
只有在需要时才应使用这种类型的注释。
有时如果使用它，它是一个糟糕的变量命名约定的标志。
以下是代码描述注释的示例。

# Player health
var x = 100

在这种情况下，代码描述的使用很糟糕。您可以通过变量名更好地描述您的代码。

var player_health = 100

通过表达您希望变量具有的值，您可以做得更好

var player_health: int = 100

何时使用评论

有句话说：
代码告诉你怎么做，注释告诉你为什么
尝试使用命名约定来提高代码的可读性。
当您达到该限制时，请使用注释来解释您的代码的基本原理。