如何在打字稿中正确评论/记录地图对象答案

【问题标题】：How to properly comment/document for Map object in typescript如何在打字稿中正确评论/记录地图对象
【发布时间】：2019-03-20 11:04:19
【问题描述】：

地图对象 (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map)

例如，

private _fruit: Map<string, FruitDetail> = new Map();

它通常带有类似的方法，

public setFruit(fruitName: string, fruitDetail: FruitDetail) {...}

public getFruit(fruitName: string): FruitDetail {...}

但是属性中只声明了string类型，我怎么让别人知道它应该是fruitName而不是fruitColor？

【问题讨论】：

是否都定义为字符串fruitName和fruitColor？
@NarendraMongiya 好吧，这只是一个例子。我很好奇如何清楚地让其他人知道我正在为这张地图做什么，以及如果他们计划扩展或部分更改它，他们应该如何管理结构。

标签： javascript typescript

【解决方案1】：

如果您只想记录映射键的含义，可以使用类型别名：

private _fruit: Map<FruitName, FruitDetail> = new Map();

// Outside the class
type FruitName = string;

FruitName 仅用于文档；如果你还定义了FruitColor = string，那么如果你混淆了FruitNames 和FruitColors，TypeScript 就不会报错。如果您想要一个错误，您可以使用“品牌”字符串类型。一位web search 为我找到了一些教程，包括this one，这与我在一个项目中使用的最接近。

【讨论】：