如何在GDscript中使用注释文档？

Question

我试图弄清楚 Godot 文档注释是如何工作的。我将它们应用到我的代码中，但在代码编辑器或属性检查器中没有看到任何提示。

应该在哪里显示？我怎样才能看到这些提示？

相关的子问题有没有办法记录函数参数？

Godot 文档注释：“如果记录了导出的变量，则其描述将用作编辑器中的工具提示。该文档可以由编辑器生成为 XML 文件。”

但是导出关键字已经在使用，或者我弄错了？并且没有关于如何记录函数参数的信息。

Answer 1

您正在查看的文档适用于 Godot 4.0。注释文档是 Godot 4.0 的一项功能，在 Godot 3.x 中不起作用。我怀疑你正在使用 Godot 3.x，因为你说：

导出关键字已在使用

在 Godot 4.0 中，export 不再是关键字。相反，它是一个注释。

关于记录参数，Godot 不会生成每个参数的文档。请参阅 Godot 提供的任何类的方法描述以了解我的意思。

在撰写本文时， 和 也是 Godot 4.0 源代码中唯一受支持的标签@desc。@tutorial而是对描述中的参数进行解释。我相信约定是将参数名称放在[code]和之间[/code]。重申一下，这是 Godot 4.0 的一项功能。