Skip to content

注释

什么是注释

gdscript
#这是一条注释
#这是一条注释

注释就是这么简单,写一个井号,井号和它后面的内容在代码执行时会被忽略。这就叫做单行注释。
注释还有一种形式,就是多行注释。三个双引号之间无论有多少行内容,都属于注释。

gdscript
"""
这是注释
这也是注释
"""
"""
这是注释
这也是注释
"""

注释的作用

调用表达式其实已经出现过注释了,相信你也体会到了它的作用。还是字面意思,注释用于在代码中解释代码,可以增强程序的可读性,也便于维护。
尤其在长期开发维护或者多人协作的项目中,一定要多写注释,帮助别人或者未来的你理解现在的你写的代码。

什么时候需要用到注释?

这是一些通常需要注释的场景,但并不绝对,需要根据实际情况灵活变通

  • 一段比较复杂的逻辑中
  • 在一个文件或者一个函数、对象(这些概念会在后面介绍)开头用多行注释[1]介绍它的作用
  • 用注释标记还需要修改或者优化的地方

避免注释

有的时候需要用到井号但并不是想用注释,比如输出#这是一条注释这句话。这时候应该怎么做呢?答案还是转义


  1. GDScript documentation comments ↩︎