(Unity3D) 如何在脚本上添加注释或文档答案

【问题标题】：(Unity3D) How to put note or documentation on script(Unity3D) 如何在脚本上添加注释或文档
【发布时间】：2020-07-24 16:08:27
【问题描述】：

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

【问题讨论】：

标签： c# unity3d game-engine unity3d-editor

【解决方案1】：

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

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

类似的东西：

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

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

这里有一个second link，它提供了更多信息。

【讨论】：

因为它只是一个函数调用，您不必引用任何人或提供链接。如果 tat 是另一个网站上的另一个人编写的长代码，那么您也应该引用并链接它们。尽管您的最后一个链接很有帮助。
@Programmer 我不得不承认，驱使我发表免责声明的原因是我懒得用我自己的话重写我发现的内容；）
@Zarashi99 请不要忘记接受这个答案，因为它解决了你的问题。

【解决方案2】：

也许Tooltipattribute 就足够了。它允许您记录您的公共字段，以便在鼠标悬停时显示工具提示弹出窗口。
s。 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;

看起来像

【讨论】：