GDScript 文档注释 ¶

## The description of the variable.
## @deprecated: Use [member other_var] instead.
var my_var
或者你也可以手动调用 sphinx-build 程序来构建文档：:
enum MyEnum { ## My enum.
    VALUE_A = 0, ## Value A.
    VALUE_B = 1, ## Value B.
const MY_CONST = 1 ## My constant.
var my_var ## My variable.
signal my_signal ## My signal.
func my_func(): ## My func.
class MyClass: ## My class.
只要脚本内容发生变化，该脚本的类文档便会自动更新。若存在以下划线开头的变量或函数，则该变量/函数就会视为私有变量/私有函数，不会显示在该脚本的脚本类文档当中。
完整脚本示例¶
extends Node2D
## A brief description of the class's role and functionality.
## The description of the script, what it can do,
## and any further detail.
## @tutorial:             https://example.com/tutorial_1
## @tutorial(Tutorial 2): https://example.com/tutorial_2
## @experimental
## The description of a constant.
const GRAVITY = 9.8
## The description of a signal.
signal my_signal
## This is a description of the below enum.
enum Direction {
    ## Direction up.
    UP = 0,
    ## Direction down.
    DOWN = 1,
    ## Direction left.
    LEFT = 2,
    ## Direction right.
    RIGHT = 3,
## The description of the variable v1.
var v1
## This is a multiline description of the variable v2.[br]
## The type information below will be extracted for the documentation.
var v2: int
## If the member has any annotation, the annotation should
## immediately precede it.
@export
var v3 := some_func()
## As the following function is documented, even though its name starts with
## an underscore, it will appear in the help window.
func _fn(p1: int, p2: String) -> int:
    return 0
# The below function isn't documented and its name starts with an underscore
# so it will treated as private and will not be shown in the help window.
func _internal() -> void:
## Documenting an inner class.
## The same rules apply here. The documentation must
## immediately precede the class definition.
## @tutorial: https://example.com/tutorial
## @experimental
class Inner:
    ## Inner class variable v4.
    var v4
    ## Inner class function fn.
    func fn(): pass
文档注释标记 @deprecated 和 @experimental¶
你可以将一个类或其成员标记为已废弃成员或者实验性成员，标记后，引擎就会在文档查看器里自动添加上对应提示符号。你也可以选择性地提供一条对不再支持该API的原因解释。这些对插件和代码库的作者而言无疑是一大福音。
已废弃 标记不推荐的 API，该 API 可能会在未来的主要版本中移除或进行不兼容的更改。保留 API 通常是为了向后兼容。
实验性 标记了一个不稳定的新 API，该 API 可能会在当前主要分支中更改或移除。不建议在生产代码中使用该 API。
当然，技术上来说，你可以给同一个类/成员同时使用 @deprecated and @experimental 这两个标记，不过并不推荐这样做，会比较反直觉。
BBCode 与类参考¶
Godot 的类参考支持类似 BBCode 的标签。这些标签用在文档中时可以让文本格式更加美观。另见类参考 BBCode。注意：与 RichTextLabel 的 :ref:`BBCode <doc_bbcode_in_richtextlabel>`会稍有不同。
每从其他类里链接一个成员，你都要在成员名前面加上该类的类名。而链接类内成员时，类名可省略。
可用的标记如下：
使用 [codeblock]来制作预格式化代码块。在 [codeblock] 区域中，请始终使用四个空格进行缩进，解析器会删除制表符。
## Do something for this plugin. Before using the method
## you first have to [method initialize] [MyPlugin].[br]
## [color=yellow]Warning:[/color] Always [method clean] after use.[br]
## Usage:
## [codeblock]
## func _ready():
##     the_plugin.initialize()
##     the_plugin.do_something()
##     the_plugin.clean()
## [/codeblock]
func do_something():
[codeblock] 默认会高亮 GDScript 语法，用 lang 修饰符即可对其语法高亮所用的语言进行修改。目前支持下列语言的高亮：
[codeblock lang=text] 禁用语法高亮;
[codeblock lang=gdscript] 高亮 GDScript 语法;
[codeblock lang=csharp] 高亮 C# 语法（仅.NET版本有效）。