GDscript中如何使用注释文档?
How to use comment documentation in GDscript?
我想弄清楚 Godot 文档注释是如何工作的。
我将它们应用到我的代码中,但我在代码编辑器或 属性-inspector.
中没有看到任何提示
应该在哪里显示?我怎样才能看到这些提示?
相关的子问题有没有办法记录函数参数?
Godot documentation comments :
“如果记录了导出的变量,其描述将用作编辑器中的工具提示。编辑器可以将此文档生成为 XML 文件。”
但是 export 关键字已经被使用了,还是我弄错了?
并且没有关于如何记录函数参数的信息。
您正在查看的文档适用于 Godot 4.0。注释文档是 Godot 4.0 的一个特性,在 Godot 中不起作用 3.x。我怀疑你在使用 Godot 3.x 鉴于你说:
export keyword already in use
在 Godot 4.0 中,导出不再是关键字。相反,它是 annotation.
关于记录参数,Godot 不会为每个参数生成文档。 查看 Godot 提供的任何 class 的方法说明以了解我的意思。
此外,@desc
和 @tutorial
是撰写本文时 Godot 4.0 源代码中唯一支持的标签。而是对描述中的参数进行解释。我相信惯例是将参数名称放在 [code]
和 [/code]
之间。 重申一下,这是 Godot 4.0 的一个特性。
我想弄清楚 Godot 文档注释是如何工作的。 我将它们应用到我的代码中,但我在代码编辑器或 属性-inspector.
中没有看到任何提示应该在哪里显示?我怎样才能看到这些提示?
相关的子问题有没有办法记录函数参数?
Godot documentation comments : “如果记录了导出的变量,其描述将用作编辑器中的工具提示。编辑器可以将此文档生成为 XML 文件。”
但是 export 关键字已经被使用了,还是我弄错了? 并且没有关于如何记录函数参数的信息。
您正在查看的文档适用于 Godot 4.0。注释文档是 Godot 4.0 的一个特性,在 Godot 中不起作用 3.x。我怀疑你在使用 Godot 3.x 鉴于你说:
export keyword already in use
在 Godot 4.0 中,导出不再是关键字。相反,它是 annotation.
关于记录参数,Godot 不会为每个参数生成文档。 查看 Godot 提供的任何 class 的方法说明以了解我的意思。
此外,@desc
和 @tutorial
是撰写本文时 Godot 4.0 源代码中唯一支持的标签。而是对描述中的参数进行解释。我相信惯例是将参数名称放在 [code]
和 [/code]
之间。 重申一下,这是 Godot 4.0 的一个特性。