如何向暴露的属性添加文档？

Question

我想在自定义组件中添加文档。该文档应该在编辑器中可见。

它似乎已经可用于标准库组件：

但是，它对我的​​代码不起作用：

using UnityEngine;
using System.Collections;

public class MainPlayer : MonoBehaviour {
    // I would like to see this comment in the editor too!
    public string myName;

    // Use this for initialization
    void Start () {
        Debug.Log("I am alive and my name is " + myName);
    }

    // Update is called once per frame
    void Update () {

    }
}

我该怎么做？

Answer 1

您需要做的就是用Tooltip属性装饰字段。 示例：

[Tooltip("These are not droids you are looking for...")]
public string myName;

此外，如果我是你，我会[Header()]属性方式，因为它总是会在Inspector中的字段上方显示粗体标题，而不是仅显示有关悬停的信息。

标题和其他属性的文档： http://docs.unity3d.com/ScriptReference/HeaderAttribute.html

我担心没有直接链接到整个部分，因此您需要在左侧的导航栏中导航到名为 Attributes 的部分，该部分应该从开始处于活动状态。