Unity开发——编辑器面板与脚本里的变量方法等的注解显示

15 篇文章 0 订阅
6 篇文章 0 订阅

1、多脚本使用时可快捷查看变量/方法的注解:summary

    /// <summary>
    /// 注释说明
    /// </summary>
    public void 字段/属性/方法名(参数){...}

只要字段/属性/方法的声明定义处头上有添加summary注释,

不论是否是同个脚本内,鼠标移动到字段/属性/方法名上,

都能看到关于字段/属性/方法在summary里写的注解;

    /// <summary>
    /// 粒子量设置发生改变
    /// </summary>
    /// <param name="togIndex"></param>
    /// <param name="select"></param>
    public void SelectQuantityTog(int togIndex,bool select){...}

2、面板上显示数据详情:Serializable

using System库里的Serializable方法,

使脚本里定义的数据可以在Unity面板显式展现;

注:添加Serializable的属性字段,必须是public修饰;

数据可以是类,也可以是自定义列表数组等

using System;

public class RSEffectPropertyPanel : MonoBehaviour
{
    [Serializable]
    public class EffectData
    {
        public float min;
        public float mid;
        public float big;
        public float max;
    }
    public EffectData effectData = new EffectData();

    ...
    ...
    ...
}

3、面板显示字段变量的注解 :Header

[Header("注释/说明信息")]

public 类型 字段;

在字段属性多的时候,利用该方法有利于对字段进行划分,便于脚本和编辑器配合开发。

代码: 

using UnityEngine;
using UnityEngine.UI;

/// <summary>
/// 枪
/// </summary>
public class Gun : MonoBehaviour
{
    [Header("枪:")]
    public int level = 1;
    public int gunLevel = 1;//初始枪的等级1
    public float attackCD = 1;
    private float GunCD = 4;
    private float rotateSpeed = 5f;
    public GameObject[] Bullects;//3种枪
    public GunChange[] gunChange;//升级/降级枪的等级
    public AudioClip[] bullectAudios;//射击时的音乐
    private AudioSource bullectAudio;

    [Header("其他对象:")]
    public GameObject net;//渔网
    public int gold = 100;//初始金币1000
    public Text goldText;//金币显示文本
    public int diamands = 50;//初始钻石1000
    public Text diamandsText;//钻石显示文本
    public Transform attackPos;//攻击位置
    public Transform goldPlace;//捕鱼生成的金币移动位置
    public Transform diamondsPlace;//捕鱼生成的钻石移动位置
    public Transform imageGoldPlace;//宝箱生成的金币移动位置
    public Transform imageDiamandsPlace;//宝箱生成的钻石移动位置

    [Header("开关:")]
    public bool attack = false;
    public bool Fire = false;
    public bool Ice = false;
    public bool Butterfly = false;
    public bool bossAttack = false;
    public bool changeAudio;
    public bool canChangeGun = true;
    public bool canShootNoCD = false;
    private bool canShootForFree = false;
    private bool canGetDoubleGold = false;

    ...

}

 Unity面板显示:

 4、面板上动态显示字段的注解:Tooltip

默认情况,脚本对字段的注解内容不显示在面板上,

但当鼠标移到面板上的字段上,显示注释说明;

[Tooltip("注释/说明信息")]
public float min;

该方法满足:在字段属性过多时,需要对字段查看,又想要保持面板清爽整洁的需求;

[Tooltip("少量粒子数")]
public float min;

  • 2
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值