📜  Dart – 评论

📅  最后修改于: 2021-09-02 05:44:24             🧑  作者: Mango

在每种编程语言中,注释对于将来或任何其他程序员更好地理解代码都起着重要作用。注释是一组不打算由编译器执行的语句。他们提供了正确的代码文档。

Dart评论的类型:

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

1. Dart单行注释: Dart单行注释用于注释一行,直到发生换行。它是使用双正斜杠 (//) 完成的。

// This is a single line comment. 

例子:

Dart
int main() 
{ 
  double area = 3.14 * 4 * 4; 
  // It prints the area
  // of a circle of radius = 4 
  print(area); 
  
return 0; 
}


Dart
int main() 
{ 
  var lst = [1, 2, 3]; 
    
  /* 
  It prints 
  the whole list 
  at once 
  */ 
  print(lst); 
    
return 0; }


Dart
bool checkEven(n){ 
  /// Returns true
  /// if n is even 
  if(n%2==0) 
  
      return true; 
  /// Returns fakse if n is odd 
  else 
  
      return false; } 
  
int main() 
{ 
  int n = 43; 
  print(checkEven(n)); 
  return 0; 
}


输出:

50.24

2. Dart Multi-Line Comment: Dart多行注释用于注释掉整段代码。它分别使用 ‘/*’ 和 ‘*/’ 开始和结束多行注释。

/* 

These are 

multiple line 

of comments 

*/ 

例子:

Dart

int main() 
{ 
  var lst = [1, 2, 3]; 
    
  /* 
  It prints 
  the whole list 
  at once 
  */ 
  print(lst); 
    
return 0; }

输出:

[1, 2, 3]

3. Dart文档注释: Dart文档注释是一种特殊类型的注释,用于提供对包、软件或项目的引用。 Dart支持两种类型的文档注释“///”(C# 风格)和“/**…..*/”(JavaDoc 风格)。首选使用“///”作为文档注释,因为很多时候 * 用于标记项目符号列表中的列表项,这使得阅读注释变得困难。建议使用文档注释来编写公共 API。

/// This is 

/// a documentation 

/// comment 

例子:

Dart

bool checkEven(n){ 
  /// Returns true
  /// if n is even 
  if(n%2==0) 
  
      return true; 
  /// Returns fakse if n is odd 
  else 
  
      return false; } 
  
int main() 
{ 
  int n = 43; 
  print(checkEven(n)); 
  return 0; 
} 

输出:

false