HelpURLAttribute
Provide a custom documentation URL for a class.
阅读时间3 分钟最后更新于 1 个月前
Definition
- Type: Class
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
- Inherits from: Attribute
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false)]public class HelpURLAttribute : Attribute
Remarks
The provided URL is expected to be an absolute path. If no file is found at the URL, the path is resolved relative to the Unity documentation, which can be either the manual or scripting reference.
Examples
using UnityEngine;using UnityEditor;[HelpURL("http://example.com/docs/MyComponent.html")]public class MyComponent{}
Constructors
Constructor | Description |
|---|---|
| HelpURLAttribute(System.String) | Initialize the HelpURL attribute with a documentation url. |
Properties
Property | Description |
|---|---|
| URL | The documentation URL specified for this class. |