在 TypeScript 中命名抽象类和接口 [关闭]

Question

关闭。 这个问题是基于意见的。 它目前不接受答案。

---

想改善这个问题吗？ 更新问题，以便通过编辑这篇文章用事实和引文来回答问题。

4年前关闭。

改进这个问题

这个问题存在争议，没有一致性，所以我想澄清打字稿的类、文件名、后缀和其他的命名标准。 我想知道，在 Typescript 项目中，您如何命名抽象类、接口和逻辑组织代码？

可能的解决方案：

对于接口：

• 以“我”为前缀
• 以“接口”为后缀
• 完全没有添加任何东西

对于抽象类：

• 以“摘要”为前缀
• 像“Base”这样的前缀
• 一无所有

C# 示例

public class User : AbstractUser, IUser

在 Java 和 PHP 中相同

public class User extends AbstractUser implements UserInterface

在打字稿中

export class User extends AbstractUser implements UserInterface

这是在基于 C#、Java 和现代 PHP7+ 等语言的框架中使用的常规方法

---

Microsoft 建议添加“Interface”作为后缀，这对我来说是正确的。 https://github.com/Microsoft/TypeScript-Handbook/blob/master/pages/Interfaces.md#class-types

另一个流行的风格指南建议不要为接口的前缀添加任何后缀，因为我违反了规则，可读性和整体看起来都是错误的。 https://basarat.gitbooks.io/typescript/content/docs/styleguide/styleguide.html#interface

export class User extends AbstractUser implements User

Answer 1

我认为这是一个品味问题。

如果用户对象可以用纯 JSON 描述，我会使用接口名称User而不是IUser或UserInterface ，因此是一个没有类行为的纯数据对象。 因为您可能永远不需要实现类，所以您始终可以使用对象字面量：

interface User {
    name: string;
    email: string;
}

function createDummyUser(): User {
    return {
        name : "Alice",
        email: "a@wonder.land"
    }
}

我会使用对象抽象类的普通名称（如“Car”），并为非抽象类使用特定名称（如“Beetle”）。 您可以通过保护构造函数来确保您的抽象实现不会被错误使用：

class Car {
    protected constructor() {
    }
}

const fail = new Car();  // error because c'tor is protected

class Beetle extends Car {
       public constructor(){
           super();
       }
}

let itBe = new Beetle();  // here we go!

Answer 2

我们的节点应用程序对接口的要求很高——它们无处不在，我们进行类型检查和类型提示，因此有意义的名称对我们来说非常重要。

import {MediaInterface} from 'app/models/mediaInterface';
import {ServerInterface} from 'app/server/serverInterface';
import {UserInterface} from 'app/models/userInterface';

export class MediaStorage extends AbstractStorage implements StorageInterface {

  /**
   * current user
   * @private
   */
  private user: UserInterface;

  /**
   * @constructor
   * @param {ServerInterface} app
   */
  constructor(private app: ServerInterface) {
    // ...
  }

  /**
   * @param {UserInterface} user
   * @returns {Promise<any>}
   */
  public deleteUserMedia(user: UserInterface): Promise<any> {
    // ...
  }

  /**
   * @param {object} req request
   * @param {object} res response
   * @returns {Promise<MediaInterface>}
   */
  public create(req: any, res: any): Promise<MediaInterface> {
     // ...
  }

}