在Angular和typescript中写注释的教程

626 阅读2分钟

注释是代码中的一段语句,在Typescript编译过程中会被忽略。每种编程语言都提供注释。

Typescript是javascript的超集,所以它支持javascript提供的同样的语法。

注释对于开发者来说是非常有用的,可以方便地修改代码,可以重复使用,并且可以帮助其他开发者更好地理解代码。

它为每段代码提供了额外的注释,如下所示

  • 作者
  • 创建和修改日期
  • 版本
  • 关于方法/类/和任何需要提供更多信息的代码的描述。
  • 文档元标签

在将typescript转译成javascript的过程中,注释会被复制到javascript中而不作任何修改。

在typecript中,有三种注释类型

  1. 单行注释
  2. 多行注释
  3. 文档注释

它是用来对代码行进行简短描述的。你可以在单独的一行或内联中包含一个注释。单行注释总是以//符号开始。

语法

下面是一个单行注释的例子

`// MyClass implementation  
class MyClass {  
    msg: string;  
    constructor(message: string) { // Constructor  
        this.msg = message;  
    }  
`

##   Multi-Line comments 

  

多行意味着包含多于一行的注释。这可以通过使用/* */来表示。

语法

/*  
* Line One  
* Line two  
* Line Three  
*/  

下面是一个多行注释的例子

  
/*  
* Class Declaraiton for Emp class  
*/  
class Emp {  
    name: string;  
    /*  
    * Constrcutor for Emp class  
    */  
    constructor(name: string) {   
        this.name = name;  
    }  
}  

当你想使用文档生成器API库(如JSDocESDocTypeDoc)为你的代码生成文档时,会用到文档注释。这些注释类似于多行注释,唯一的区别是多了一个星号,它包含元标签和HTML标签。语法

  
/**  
* Documentation comments  
*/  

下面是一个用于文档生成器的JSDOc注释示例

它包含文本和以@符号为前缀的标签,这些标签有特殊的含义。

/**  
 * This is a hello world function.  
 * @author Kiran Babu  
 * @version 1.0.0  
 * @param {string} value - A string param  
 * @return {string} Return a string  
 * @example  
 * welcome('Welcome')  
 */  
function welcome(msg): string { return msg }  

Angular使用typescript作为一种编程语言。所有类型的注释都可以在Angular 10/11/12版本中使用。
评论可以被添加到Angular组件中,无论是在Typescript代码还是在html模板中。

import { Component } from '@angular/core';  
  
@Component({  
  selector: 'app-root',  
  templateUrl: './app.component.html',  
  styleUrls: ['./app.component.css']  
})  
/*  
* Application Component   
*/  
export class AppComponent {  
    count: number = 0;  
// Event Method for incrementing counter value by one  
  clickEvent() {  
        this.count++;  
    }  
}  

Angular组件有一个模板属性,可以接受HTML字符串。以上三种评论类型将无法工作。这些都是HTML标签,所以HTML注释可以使用。
语法

下面是一个Angular模板HTML注释的例子

@Component({  
  selector: 'my-app',  
  template: `  
    
    {{msg}}  
   
    {{name}}  
    `  
  `  
})  

总结

我们学习了在Angular和typescript中写注释。在这个教程中,你可以在Typescript中写单行、多行和文档注释。包括在Angular typescript和模板HTML组件中声明评论