我阅读了TypeScript编码指南
我发现这句话令人费解:
不要使用“ I”作为接口名称的前缀
我的意思是,如果没有“ I”前缀,这样的事情将毫无意义
class Engine implements IEngine
我是否缺少明显的东西?
我不太了解的另一件事是:
班级
为了保持一致性,请勿在核心编译器管道中使用类。请改用函数闭包。
那说明我根本不应该使用类吗?
希望有人可以帮我清理一下:)
我阅读了TypeScript编码指南
我发现这句话令人费解:
不要使用“ I”作为接口名称的前缀
我的意思是,如果没有“ I”前缀,这样的事情将毫无意义
class Engine implements IEngine
我是否缺少明显的东西?
我不太了解的另一件事是:
班级
为了保持一致性,请勿在核心编译器管道中使用类。请改用函数闭包。
那说明我根本不应该使用类吗?
希望有人可以帮我清理一下:)
I
用来表示一个界面,因为它是我所习惯的,并且对我团队中的人们来说是有意义的。
Answers:
当团队/公司交付框架/编译器/工具集时,他们已经具有一些经验和最佳实践。他们将其作为准则。准则是 建议。如果您不喜欢它们,可以忽略它们。编译器仍然会编译您的代码。虽然在罗马...
这就是我的愿景,为什么TypeScript团队建议不使用I
前缀接口。
I
-prefix-for-interface支持者的主要观点是,前缀有助于立即查看(窥视)类型是否为接口。前缀有助于立即进行(偷看)的声明吸引了匈牙利符号。I
接口名称,C
类,A
抽象类,s
字符串变量,c
const变量,i
整数变量的前缀。我同意这种名称修饰可以为您提供键入信息,而无需将鼠标悬停在标识符上方或通过热键导航到类型定义。匈牙利符号缺点和下面提到的其他原因远远超过了这种微小的好处。匈牙利符号未在当代框架中使用。C#有I
由于历史原因(COM),接口的前缀(这是C#中唯一的前缀)。回顾一下,.NET架构师之一(Brad Abrams)认为最好不要使用I
prefix。TypeScript不具有COM传统功能,因此没有I
-prefix-for-interface规则。
I
前缀违反封装原理假设您有一些黑匣子。您将获得一些类型引用,该引用可让您与该框进行交互。您不必关心它是接口还是类。您只需使用其界面部分。要求知道它是什么(接口,特定实现或抽象类)违反了封装。
示例:假设您需要在代码中修复API设计误区:接口作为合同,例如删除ICar
接口并改用Car
基类。然后,您需要在所有使用者中执行此类替换。I
-prefix导致使用者暗中依赖黑盒实现细节。
开发人员懒于正确考虑名称。命名是计算机科学的两大难题之一。当开发人员需要提取接口时,只需将字母添加I
到类名中就很容易,您将获得一个接口名。禁止I
使用接口前缀会迫使开发人员竭尽全力为接口选择合适的名称。选择的名称不仅应在前缀上不同,而且应强调意图差异。
抽象情况:你应该不会没有定义的ICar
接口和相关的Car
类。Car
是一种抽象,应该是用于合同的一种。实现应具有描述性的独特名称,例如SportsCar, SuvCar, HollowCar
。
很好的例子:WpfeServerAutosuggestManager implements AutosuggestManager
,FileBasedAutosuggestManager implements AutosuggestManager
。
错误的例子: AutosuggestManager implements IAutosuggestManager
。
在我的实践中,我遇到了很多人,他们在具有Car implements ICar
命名方案的单独接口中无意中重复了类的接口部分。在单独的接口类型中复制类的接口部分不会神奇地将其转换为抽象。您仍将获得具体的实现,但是具有重复的接口部分。如果您的抽象不是很好,那么复制接口部分将无法改善它。提取抽象是艰苦的工作。
注意:在TS中,您不需要用于模拟类或重载功能的单独接口。可以使用TypeScript实用程序类型来代替创建描述类的公共成员的单独接口,而不必使用其他接口。例如,Required<T>
构造一个由type的所有公共成员组成的type T
。
export class SecurityPrincipalStub implements Required<SecurityPrincipal> {
public isFeatureEnabled(entitlement: Entitlement): boolean {
return true;
}
public isWidgetEnabled(kind: string): boolean {
return true;
}
public areAdminToolsEnabled(): boolean {
return true;
}
}
如果要构造排除某些公共成员的类型,则可以使用Omit和Exclude的组合。
I
前缀有助于立即了解类型是否具有实现。使用接口的主要优点是不将外部代码的实现细节耦合到特定的实现。
I
和Impl
是硬(“只有两种计算机科学坚硬的东西:缓存失效和命名的事情”菲尔- Karlton),但是是可行的。
关于您引用的链接的说明:
这是有关TypeScript代码样式的文档,而不是有关如何实现项目的样式指南。
如果使用I
前缀对您和您的团队有意义,请使用它(我愿意)。
如果没有,也许Java风格的SomeThing
(接口)和SomeThingImpl
(实现)都可以使用它。
In general, do not prefix interfaces with I (e.g. IColor). Because the concept of an interface in TypeScript is much more broad than in C# or Java, the IFoo naming convention is not broadly useful.
并不严格,但看起来很推荐。
I
。在一个React工程中,有Card
一个是接口,一个是的组件Card
。在道具中,我需要一个数组Card
,但类型不是组件。我必须选择命名ICard
还是CardComponent
...
SomeThingImpl implements SomeThing
和一样好SomeThing implements ISomeThing
。如果SomeThing
是抽象,则命名应为Concrete[Some]Thing implements SomeThing
。
作为接口的类型是实现细节。实现细节应隐藏在API:s中。这就是为什么你应该避免I
。
您应避免同时使用prefix
和 suffix
。这些都是错误的:
ICar
CarInterface
您应该做的是在API中显示一个漂亮的名称,并在实现中隐藏一个实现细节。这就是为什么我建议:
Car
-API中公开的接口。CarImpl
-对使用者隐藏的该API的实现。Impl
后缀会产生副作用,即用I
Bob叔叔替换所有以您为荣的前缀。
I
前缀对您和您的团队有意义,请使用它。如果没有,也许Java风格的SomeThing
(接口)和SomeThingImpl
(实现)都可以使用它。