1. 导言

这份指南基于谷歌内部的 TypeScript 风格指南,但在其基础上做了些许调整,删去了仅适用于谷歌内部的部分内容。这是由于谷歌内部对 TypeScript 的使用方式有着不同于外部其它环境的限制,因此,尽管这些内容对有意向谷歌官方项目提交代码的开发者而言十分有用,却并不一定适合其它的开发环境。

本指南并非定期自动部署,而是由志愿者们根据需求进行维护与更新。

1.1. 术语说明

指南中对 必须、禁止、应当、不应、可以 等术语的用法遵循 RFC 2119 中的规定。术语 倾向于避免 分别对应 应当不应。命令式和声明式的语句与术语 必须 相对应,表示其内容是规定性的。

1.2. 指南说明

文中的所有示例 均非规范性示例,仅用于对指南中的规范性说明加以演示。也就是说,虽然这些示例遵循谷歌的代码风格,但它们并不一定是唯一符合规范的写法。因此,示例中选用的代码样式不能作为规则强制执行。

1.3. 翻译信息

1.3.1. 上次更新日期

2024 年 02 月 29 日。

1.3.2. 译者

1.3.3. 原文链接

Google TypeScript Style Guide

1.3.4. 中文版链接

谷歌 TypeScript 风格指南

1.3.5. 修订历史

  • 2021 年 09 月 02 日: Frank Li 提交了第一个版本。

  • 2024 年 02 月 29 日: Frank Li 重新修订了所有内容。