Unity 常用注解

目录

一、参考

1、代码中注释，目的：鼠标移动到函数或者变量上面就有了提示

1、对Unity隐藏，使用[HideInInspector]

1、对Unity暴露，使用[SerializeField]

1、结构体要暴露给Unity,使用[System.Serializable]

1、hierarchy上的注释， [Tooltip("左右移动速度")]鼠标移动上面会提示 [Range(5,20)]数值范围

---

 

一、参考

https://blog.csdn.net/chy555chy/article/details/78968285

https://www.cnblogs.com/36bian/p/7571398.html

1、代码中注释，目的：鼠标移动到函数或者变量上面就有了提示

/// <summary>
/// asset被创建完，文件生成在磁盘上但没有生成.meta文件和import之前调用
/// </summary>
/// <param name="newFileMeta">是由创建文件的path加上.meta组成的</param>

/// <summary>
/// asset被创建完，文件生成在磁盘上但没有生成.meta文件和import之前调用
/// </summary>
/// <param name="newFileMeta">是由创建文件的path加上.meta组成的</param>


  /// <summary>音乐数组</summary>

1、对Unity隐藏，使用[HideInInspector]

using UnityEngine;
  using System.Collections;
  
  public class NewBehaviourScript:MonoBehaviour{
    [HideInINspector]//起作用
    public int bb = 2; 
  }

1、对Unity暴露，使用[SerializeField]

  using UnityEngine;
  using System.Collections;
  
  public class NewBehaviourScript:MonoBehaviour{
      [SerializeField]//起作用
      private int bb = 2; 
  }

1、结构体要暴露给Unity,使用[System.Serializable]

using UnityEngine;
  using System.Collections;
  
  [System.Serializabel]//起作用
  public class CustomStruct
  {
  }
  public class NewBehaviourScript:MonoBehaviour{
    public CustomStruct Cus;//引用后即可
  }

1、hierarchy上的注释， [Tooltip("左右移动速度")]鼠标移动上面会提示 [Range(5,20)]数值范围

public class CharactorController : MonoBehaviour {
    [Header("移动")]
    [Tooltip("左右移动速度")]
    [Range(5,20)]
    public float speed = 10;

    [Header("跳跃")]
    [Tooltip("跳跃高度")]
    public float jumpHeight = 50;
    [Tooltip("连跳次数")]
    public float jumpTimes = 1;

    [Header("地面检测")]
    [Tooltip("落地检测的高度")]
    public float distance = 0.1f;
    [Tooltip("地面层")]
    public LayerMask mask;

    [Header("私有属性序列化")]
    [SerializeField]
    private bool isJumping = false;
}