什么是 TypeScript？

TypeScript（简称 TS）是一种由微软开发的自由和开源的编程语言，它是 JavaScript 的一个超集，扩展了 JavaScript 的语法和功能。TypeScript 可以编译成纯 JavaScript，这意味着开发人员可以利用现有的 JavaScript 库和框架，同时也能享受到 TypeScript 的优势。

TypeScript 中的注释

在 TypeScript 中，注释是一种非常有用的方式，可以帮助开发人员理解代码的结构和功能。在本节中，我们将介绍 TypeScript 中常用的注释类型。

单行注释和多行注释

在 TypeScript 中，我们可以使用注释来帮助我们理解代码的功能和结构，TypeScript 支持两种类型的注释：单行注释和多行注释。

单行注释

在 TypeScript 中，我们使用 // 来创建单行注释，单行注释只能放在一行的末尾，它后面的所有内容都会被编译器忽略。

// 声明一个变量 x
let x = 5;

多行注释

在 TypeScript 中，我们使用 /* 和 */ 来创建多行注释，多行注释可以跨越多行，它内部的所有内容都会被编译器忽略。

/* 这是一个多行注释，它可以跨越多行 */ 
let y = 10;

特殊注释类型

JSDoc 注释

JSDoc 是一个用于描述 JavaScript 代码的标记语言，在 TypeScript 中，我们可以使用 JSDoc 注释来生成文档，JSDoc 注释以 /** 开始，以 */ 结束。

/**
 * 这是一个简单的函数，用于计算两个数的和。
 * @param {number} a 第一个数。
 * @param {number} b 第二个数。
 * @returns {number} 两个数的和。
 */
function add(a, b) {
    return a + b;
}

TODO 注释

TODO 注释用于标记代码中的未完成部分或需要后续处理的部分，在 TypeScript 中，我们使用 // TODO 来创建 TODO 注释。

// TODO: 这个函数还没有实现
function subtract(a, b) {
    // TODO: 实现减法操作
}

@internal 注释

@internal 注释用于标记代码中的私有部分，这些部分不应该被外部代码访问，在 TypeScript 中，我们使用 @internal 来创建 @internal 注释。

/** @internal */
function internalFunction() {
    // 这个函数是私有的，不应该被外部代码访问
}

@private 注释

@private 注释用于标记代码中的私有成员，这些成员不应该被外部代码访问，在 TypeScript 中，我们使用 @private 来创建 @private 注释。

class MyClass {
    /** @private */
    private myPrivateField; // 这个字段是私有的，不应该被外部代码访问
}

@public 注释

@public 注释用于标记代码中的公共成员，这些成员可以被外部代码访问，在 TypeScript 中，我们使用 @public 来创建 @public 注释。

class MyClass {
    /** @public */
    public myPublicField; // 这个字段是公共的，可以被外部代码访问
}

@protected 注释

@protected 注释用于标记代码中的受保护成员，这些成员可以被派生类访问，但不能被外部代码访问，在 TypeScript 中，我们使用 @protected 来创建 @protected 注释。

class MyBaseClass {
    /** @protected */
    protected myProtectedField; // 这个字段是受保护的，可以被派生类访问，但不能被外部代码访问
}

@override 注释

@override 注释用于标记一个方法或属性是重写的父类的方法或属性，在 TypeScript 中，我们使用 @override 来创建 @override 注释。

class MyDerivedClass extends MyBaseClass {
    /** @override */
    override myMethod() { // 这个方法是重写的父类的方法
        // ...实现细节...
    }
}

@abstract 注释

@abstract 注释用于标记一个类、方法或属性是抽象的，不能被实例化或直接访问，在 TypeScript 中，我们使用 @abstract 来创建 @abstract 注释。

/** @abstract */
abstract class MyAbstractClass { // 这个类是抽象的，不能被实例化或直接访问
    /** @abstract */
    abstract myAbstractMethod(); // 这个方法是抽象的，不能被直接访问或实现
}

结尾

注释是程序员日常工作中必不可少的部分，有助于我们更好地理解代码结构和功能。在 TypeScript 中，注释也是非常重要的，因为它可以帮助我们生成文档，同时也可以控制代码的行为。希望这篇文章能够对你理解 TypeScript 中的注释类型有所帮助。

如果你有任何问题或建议，请在下面的评论中留言。也欢迎关注我们的公众号，获取更多的技术资讯和学习资源。

感谢阅读！