上查看所有课程
注意: 如果您是 TypeScript 新手，请先查看我们的 TypeScript 入门 教程。
TypeScript 注释是代码中的说明，会被编译器完全忽略。
这是 TypeScript 注释的一个简单示例。您可以阅读本教程的其余部分以了解更多信息。
示例
// Display "Programiz" to the screen
console.log("Programiz");
// Output: Programiz这里，// Display "Programiz" to the screen 是一个注释。因此，TypeScript 引擎会忽略它。
TypeScript 中的注释类型
在 TypeScript 中，有两种添加代码注释的方法
//- 单行注释/* */- 多行注释
单行注释
在 TypeScript 中，任何以 // 开头的行都是单行注释。例如，
let name: string = "John Doe";
// Display name on the console
console.log("Hello " + name);输出
Hello John Doe
这里，// Display name on the console 是一个单行注释，用于描述 console.log("Hello " + name); 的作用。
请注意，注释在 console.log() 的上方。在 TypeScript 中，您也可以在代码旁边使用单行注释。
let name: string = "John Doe";
console.log("Hello " + name); // Display name on the console但是，如果注释很长且描述性强，请避免这样使用注释。
多行注释
在 TypeScript 中，多行注释允许您添加可以跨越多行的注释。它们以 /* 开始，以 */ 结束。例如，
/* Create a string variable
and print it to the console
*/
let name: string = "John Doe";
console.log(name);在这里，我们使用了一个可以跨越多行的多行注释。
注意：您可以在 /* 和 */ 之间包含单行注释，但使用 // 更方便。
用于删除不需要的代码的注释
如果想要删除将来可能仍有用的代码行，注释会很有帮助。请看下面的程序。
console.log("Hello John Doe!");
console.log("Welcome to our TypeScript tutorial.");假设现在不需要该行 console.log("Welcome to our TypeScript tutorial.");。但您知道将来可能会改变主意。
在这种情况下，你可以简单地将不需要的行转换为注释，而不是从程序中删除它。
console.log("Hello John Doe!");
// console.log("Welcome to our TypeScript tutorial.");然后，您可以在需要时取消注释该代码。
为什么要使用注释？
作为一名 TypeScript 开发人员，您将编写代码，还需要更新或审查他人编写的代码。
如果您为自己的代码编写注释，将来您（以及您的同事）将更容易理解它。
作为经验法则，请使用注释来解释您做某事的原因，而不是如何做。
注意事项
- 不应使用注释来解释写得不好的代码。您的代码应该始终结构良好且自解释。
- 请记住使用注释的快捷方式；它可能非常有帮助。对于大多数代码编辑器，在 Windows 上是
Ctrl + /，在 Mac 上是Cmd + /。