c# - (Unity3D) 如何在脚本上添加注释或文档

Question

:) 有没有办法让我们在我们制作的自定义脚本下设置可以显示在Inspector视图上的注释或文档？

Answer 1

这个答案不是我的，它来自我在 google 上找到的链接。

你必须为你的类实现一个自定义检查器，当你想显示这样的警告时，你可以EditorGUILayout.HelpBox在里面使用OnInspectorGUI。

像这样的东西：

EditorGUILayout.HelpBox("Some warning text", MessageType.Warning);

for的MessageType参数EditorGUILayout.HelpBox有多个选项，其中一个是Info，它似乎适合显示注释，而不是警告。

这是提供更多信息的第二个链接。

Answer 2

也许Tooltip属性就足够了。它允许您记录您的公共字段，以便在鼠标悬停时显示工具提示弹出窗口。
s。https://docs.unity3d.com/ScriptReference/TooltipAttribute.html了解更多信息。

[更新] 我找到了一种开箱即用的更好方法（仍然不完美）。Header 属性
允许您直接在检查器 中显示文本，但无法包含富文本格式或图像

    [Header("--- Note ---", order=1)]
    [Space(-10, order = 2)]
    [Header("First Attribute is between 1 and 10", order = 3)]
    [Range(1, 10)]
    public int FirstProperty = 1;

    [Space(10, order = 4)]
    public string Hint;

好像