（Unity3D）如何在脚本上添加注释或文档

Question

:)我们是否有办法设置注释或文档，可以在自定义下的检查器视图中显示我们制作的剧本？

Answer 1

这个答案不是我的，而是来自link that I found on google。

  

您必须为您的班级实施自定义检查员，当您想要显示此类警告时，您可以在EditorGUILayout.HelpBox内使用OnInspectorGUI。

     

类似的东西：

     

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

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

这里有一个second link，可以提供更多信息。

Answer 2

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

<强> [更新] 我发现了一种更好的方法来实现这一目标（仍然不完美） Header attribute允许您直接在检查器中显示文本，但无法包含富文本格式或图像

    [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;

看起来像是