TypeScript中接口和类的命名约定是什么？

Question

我有以下内容：

interface IUser {
  email: string
  password: string
}

class User {
  email: string
  password: string
  constructor(email: string, password: string) {
    this.email = email
    this.password = password
  }

  isEmailValid(): boolean {
    return validatorJs.isEmail(this.email)
  }

  isPasswordValid(): boolean {
    return validatorJs.isStrongPassword(this.password, opts)
  }
}

function createUser(user: IUser) {
  // applying isPasswordValid and isEmailValid
  //insert ...
}

function getUser(): IUser {
  return new User('foo@bar.com', 'foobar')
}

我必须在接口名称前加上字母“I”，这是正确的还是我应该做不同的事情？

Answer 1

TypeScript 语言没有正式的命名约定，因此“正确”取决于您。 在更广泛的 TS 社区中，通常不将I用于接口，除非它们明确用于由类实现（这不一定是 TypeScript 中接口的最常见用途）。

Answer 2

答案是自以为是的。 微软这里的约定但以下是一般规范：

1. 类一般是名词，写成 PascalCase
2. 界面也是 PascalCase（不推荐前缀“I”）
3. 枚举和它的字段都是用 PascalCase 写的
4. 变量 (let/const) 以驼峰式命名。 有时const也写成UPPERCASE 。

Answer 3

有人开发了 TypeScript 风格指南。 你可以在这里找到它： https : //ts.dev/style

从该指南：

这是基于 Google 提供的 TypeScript 语言的风格指南。 它包含规则和最佳实践。 选择最适合您的团队的那些。

这是它关于接口命名的说明：

不要特别标记接口（~~IMyInterface~~ 或 ~~MyFooInterface~~），除非它在其环境中是惯用的。 当为一个类引入一个接口时，首先给它一个名称来表达接口存在的原因（例如类 TodoItem 和接口 TodoItemStorage，如果接口以 JSON 表示用于存储/序列化的格式）。

注：这两个接口名称： IMyInterface和MyFooInterface以上都应该被划掉。 我按照降价规范尝试了波浪号，但是这个工具似乎不支持，所以它们没有被划掉。