Unity 常用注解

爱被打了一巴掌 2022-06-02 04:52 252阅读 0赞

## class 注解（Annotation） ##

<table> 
 <thead> 
  <tr> 
   <th align="left">code</th> 
   <th align="left">description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">[ExecuteInEditMode]</td> 
   <td align="left">脚本在编辑模式执行，而非Runtime</td> 
  </tr> 
  <tr> 
   <td align="left">[Serializable]</td> 
   <td align="left">序列化一个类，使其能在Inspector面板中显示</td> 
  </tr> 
  <tr> 
   <td align="left">[RequireComponent(typeof(XXX))]</td> 
   <td align="left">自动添加某个组件，且该组件不能被删除。”XXX”可以是Rigidbody等</td> 
  </tr> 
  <tr> 
   <td align="left">[AddComponentMenu(“XXX/YYY”)]</td> 
   <td align="left">将脚本添加到Component菜单中。在Hierarchy中选中对象后可以快速将脚本添加到对象</td> 
  </tr> 
  <tr> 
   <td align="left">[HelpURL(“<a href="http://XXX" rel="nofollow">http://XXX</a>“)]</td> 
   <td align="left">Inspector面板右上角的“书”的默认链为：file:///C:/Program%20Files/Unity/Editor/Data/Documentation/en/ScriptReference/MonoBehaviour.html可以通过该方法修改该链接</td> 
  </tr> 
 </tbody> 
</table>

## Field 注解 ##

<table> 
 <thead> 
  <tr> 
   <th align="left">code</th> 
   <th align="left">description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">[SerializableField]</td> 
   <td align="left">序列号变量，使得private变量可以显示在Inspector面板中</td> 
  </tr> 
  <tr> 
   <td align="left">[HideInInspector]</td> 
   <td align="left">在Inspector面板中隐藏public变量</td> 
  </tr> 
  <tr> 
   <td align="left">[ColorUsage(showAlpha：bool, hdr：bool, maxBrightness：float, maxExposureValue：float, minBrightness：float, minExposureValue：float)]</td> 
   <td align="left">Color变量默认是rgba格式的，hdr=false，通过该注解可以对”拾色板”进行更具体的配置。ColorUsage具有两种重载形式：”showAlpha单参数”和”全参数”</td> 
  </tr> 
  <tr> 
   <td align="left">[Tooltip(“XXX”)]</td> 
   <td align="left">当鼠标悬停在Inspector面板的该变量时，会显示该提示</td> 
  </tr> 
  <tr> 
   <td align="left">[Space(int)]</td> 
   <td align="left">在Inspector面板的该变量上面留出相应大小的空间</td> 
  </tr> 
  <tr> 
   <td align="left">[Header(“XXX”)]</td> 
   <td align="left">在Inspector面板的该变量上添加一个加粗的标题</td> 
  </tr> 
  <tr> 
   <td align="left">[Range(min, max)]</td> 
   <td align="left">在Inspector面板中将该变量由手动填写改为滑动条控制范围附带手动填写（如果填写超出该范围的值，Unity会自动使用Mathf.Clamp()进行修改）</td> 
  </tr> 
  <tr> 
   <td align="left">[Multiline]</td> 
   <td align="left">使得单行的string在Inspector面板中变为多行的string（设置区域为原值范围）</td> 
  </tr> 
  <tr> 
   <td align="left">[TextAreaAttribute]</td> 
   <td align="left">使得单行的string在Inspector面板中变为多行的string（设置区域占整行）</td> 
  </tr> 
 </tbody> 
</table>

## method 注解 ##

<table> 
 <thead> 
  <tr> 
   <th align="left">code</th> 
   <th align="left">description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">[UnityEditor.MenuItem(“XXX/YYY”)]</td> 
   <td align="left">将static方法添加到菜单栏中</td> 
  </tr> 
  <tr> 
   <td align="left">[ContextMenu(“XXX”)]</td> 
   <td align="left">将方法添加到脚本右侧的设置菜单中（注意：这里不支持多级菜单）快捷键与字符串用空格分割，%表示Ctrl，#表示Shift。例如，”XXX %#C” 的快捷键就是 Ctrl+Shift+C</td> 
  </tr> 
 </tbody> 
</table>