概念
TypeScript 的注释与 JavaScript 的注释类似,但有一个例外。
本节课讨论了在 TypeScript 中最常见且最简单的注释方式。
注释可以为代码中的变量或函数提供更多信息。
TypeScript 中的注释语法与 JavaScript 相同。你可以使用双斜杠表示单行注释,也可以使用斜杠星号 /* 开始多行注释,并用星号斜杠 */ 结束。/* 通常用于 JSDoc 风格的注释,也常用于一次性注释掉大段代码。通过编译器选项 removeComments 可以让 TypeScript 不输出任何注释。
1let x = 1; // 这是一行注释 2 3/* 这段注释可以跨越 4多行 */ 5let y = 2;
需要注意的是,TypeScript 中文件顶部的注释有一个特殊用法:使用斜杠星号后跟感叹号 /*! 开头的注释,在将 TypeScript 转换为 JavaScript 的过程中会被保留。即使设置了 removeComments 编译选项,这类注释依然会保留在生成的 JavaScript 文件中。
感叹号的主要作用是确保在生成的 JavaScript 文件中保留原始 TypeScript 文件顶部的版权信息,从而保证版权内容能够正确传播到最终生成的代码中。