在前端开发中，使用注释是非常常见的一种方式，注释不仅能够让代码更加易读易懂，还能够辅助代码的编写和维护。而在 TypeScript 中，注释的使用也有很多值得我们注意和掌握的地方，本文将对 TypeScript 中的注释进行详细解读和指南，让我们一起来探究吧！
单行注释
在 TypeScript 中，单行注释和 JavaScript 中的单行注释一样，以 // 开头，直到行末结束。单行注释通常用于单独注释一行代码或者行末注释。
// 定义变量 example1 并赋值为 "hello, world" const example1: string = "hello, world"; // 这是行末注释
多行注释
在 TypeScript 中，多行注释和 JavaScript 中的多行注释一样，以 /* 开始，以 */ 结束，支持跨多行注释。多行注释通常用于注释整个函数或者一段代码块。
/* this is a multiline comment */ function example2(): void { console.log("example2"); }
JSDoc 注释
在 TypeScript 中，除了以上两种注释之外，还有一种非常重要的注释——JSDoc 注释。JSDoc 注释可以提供更多的信息和指导，帮助我们更好地编写和维护 TypeScript 代码，比如类型、参数、返回值、异常等。JSDoc 注释以 /** 开始，以 */ 结束，可以包含多个标记和标签，下面是一些常见的标记和标签：
@param：用于指定函数参数的类型和说明；@returns：用于指定函数返回值的类型和说明；@throws：用于指定函数抛出异常的类型和说明；@typedef：用于定义类型别名；@property：用于指定类的属性类型和说明；@class：用于指定类的类型和说明；@method：用于指定方法的类型和说明。
下面是一个使用 JSDoc 注释的例子：
-- -------------------- ---- ------- --- - -------- - ------ - ----- - ------ - ----- - -------- ------ - ------- - - - - --------- -- -------- ------ ------- -- -------- ------ - -- ------- - --- -------- -- ------ - --- --------- - ----- --- -------- - - ------- - ------ - - -- -展开代码
通过以上 JSDoc 注释，我们不仅可以清晰地了解到该函数的参数、返回值和异常，还能够更好地维护代码，比如我们修改了函数的参数类型，我们只需修改 JSDoc 注释，IDE 就会自动提示并更新代码。
需要避免的注释
在使用注释时，我们也需要注意一些不恰当的注释和避免一些误用，比如：
- 无意义的注释：注释应该能够提供更多的信息和帮助，如果注释和代码没有任何关系或者说提供的信息和代码没有多大关系，我们就需要考虑是否需要这个注释。
- 错误的注释：注释应该准确无误地描述代码，如果注释和代码不匹配或者注释本身存在错误，我们就需要更正注释或者代码。
- 复制粘贴的注释：如果我们对其他代码进行注释，并且我们只是简单地复制粘贴而没有认真阅读和理解，那么这样的注释反而会误导读者。
- 大量的注释：注释不能代替代码本身，如果我们写代码时太过依赖注释，就会让代码变得臃肿和难以阅读。
小结
通过本文的介绍和示例，我们了解了 TypeScript 中三种常见的注释方式和 JSDoc 注释的使用，还分享了一些需要避免的注释和误用。注释虽然是一种看似简单的写作方式，但在细节上仍有很多需要注意和掌握的地方。希望这篇文章能够帮助大家更好地在 TypeScript 中使用注释，写出更加清晰易懂的代码。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67943aa5504e4ea9bd8b1bf8
