文档

Unity 引擎

Unity 引擎

命名脚本

为脚本Name以帮助编译器器识别您的类。使用 Namespaces 可以逻辑组织脚本并防止类 Name 冲突。
阅读时间5 分钟最后更新于 5 天前

仔细选择脚本文件的名称以及其中声明的类非常重要。使用适当的文件名并将类组织在 Namespaces 下有助于确保编译器能够识别您的类而不会出现错误。

Script 文件名

ON脚脚本入的文件Name也将用于其中定义的类的Name。脚本的文件Name最好与其内部定义的类的NameMatch。
对于派生自内置 Unity 类型
MonoBehaviour
和
ScriptableObject
的脚本,即使文件名不匹配,Unity 仍然可以解析脚本中定义的类类型,但存在一些限制:
  • 如果在脚本中定义了多个类,Unity 会选择与 文件同名的类。
  • 如果使用 C#
    partial
    关键字跨多个文件定义单一 MonoBehaviour 派生类,则只有与
    partial
    类同名的文件才能用作组件。
注意
在类Name无法与特定文件明确匹配的All情况下,Unity 都会显示Warning。

类名称和Namespaces空间

在Project的不同部分中声明多个个NameWhen,会产生命名冲突。命名冲突的可能性随着Project缩放和贡献者数量的增加而增加。例如,一个开发者者可能编写代码来Control主要玩家角色,而另一个开发者为敌人编写等效代码。如果两个开发者都选择调用其主要的类
Controller
,编译器将无法确定代码中
Controller
引用的类用法。
为了避免类Name冲突,在 C# 编程中,最好将类组织在Namespaces空间下。命名空间空间是类的Collection,类Name为前缀的命名空间空间提供了一种完整、明确的方式来引用类。请参阅 Microsoft 文档 ON Namespaces 以了解更多信息。
在以下示例中,类
Controller1
和
Controller2
是名为
Enemy
的命名空间的成员:
命名空间 Enemy { public class Controller1 :MonoBehaviour { } public class Controller2 :MonoBehaviour { }}
您可以使用这些类的完整 Name 在代码中明确引用它们。完整的 Name 是命名空间 Plus 类 Name,在本例中分别为
Enemy.Controller1
和
Enemy.Controller2
。可以在现有类Declarations周围添加命名空间空间声明,因此无需单独更ChangeAll类的名称。您可以围绕类添加命名空间 Declarations,无论它们发生在何处,即使这些类位于不同的音频源文件中也是如此。
通过在文件顶部添加
using
指令,可以避免重复输入命名空间前缀。
using Enemy;
这会导致编译器将文件中对
Controller1
和
Controller2
的引用分别解析为
Enemy.Controller1
和
Enemy.Controller2
。如果脚本还需要引用来自不同命名空间(例如,名为
Player
的命名空间)的同名类,则必须指定命名空间前缀。如果在同一文件中使用
using
指令导入了包含冲突类名称的两个 Namespaces,则编译器会报错。

多个个Namespaces空间的限制

Unity 在Namespaces空间和 MonoBehaviour 或 ScriptableObject 类方面有指定的的限制。如果文件包含 MonoBehaviour 或 ScriptableObject 类的定义,则不能在该文件中使用多个个Namespaces空间。
Unity 在控制台台中给出以下Warning:
类 MyClass 不能存在于同一文件中的多个 Namespaces 中,即使使用预处理器指令排除了某个命名空间也是如此。如果是这种情况,请将它们Move到单独的文件中。
如果您的文件在一个命名空间中定义了 MonoBehaviour,而同一文件中的其他类在不同命名空间中定义,Unity 将无法识别 MonoBehaviour 类,并且您将无法将其用于 ON 游戏对象。此限制是在 Unity 2020.1 中引入的,旨在提高导入和编译速度,因此,引入此限制之前编写的一些较旧的 Asset Store(资源商店)包可能会因此产生不正确的函数。要解决与此问题相关的问题,请将每个命名空间中的类的代码分离出来以分离文件。

其他资源