- 单行注释以 // 开始。
- 多行注释以 /_ 开始， _/ 结尾。 多行注释 可以 嵌套。
- 文档注释可以使用 /// 开始， 也可以使用 /\*_ 开始 并以 _/ 结束。

```dart
main() {
  // TODO: refactor into an AbstractLlamaGreetingFactory?
  print('Welcome to my Llama farm!');
}

main() {
  /*
   * This is a lot of work. Consider raising chickens.

  Llama larry = new Llama();
  larry.feed();
  larry.exercise();
  larry.clean();
   */
}

/// A domesticated South American camelid (Lama glama).
///
/// Andean cultures have used llamas as meat and pack
/// animals since pre-Hispanic times.
class Llama {
  String name;

  /// Feeds your llama [Food].
  ///
  /// The typical llama eats one bale of hay per week.
  void feed(Food food) {
    // ...
  }

  /// Exercises your llama with an [activity] for
  /// [timeLimit] minutes.
  void exercise(Activity activity, int timeLimit) {
    // ...
  }
}
```


dart.md

Go 语言支持 C 风格的块注释 /\* \*/ 和 C++风格的行注释 //。

- 每个包都应包含一段包注释，即放置在包子句前的一个块注释。
- 对于包含多个文件的包， 包注释只需出现在其中的任一文件中即可。
- 包注释应在整体上对该包进行介绍，并提供包的相关信息。

在每个源文件的包声明前紧跟着的注释是包注释（§10.7.4）。
通常，包注释的第一句应该先是包的功能概要说明。
一个包通常只有一个源文件有包注释。
如果包注释很大，通常会放到一个独立的 doc.go 文件中。

```go
/*
  regexp 包为正则表达式实现了一个简单的库。

  该库接受的正则表达式语法为：

  正则表达式:
    串联 { '|' 串联 }
  串联:
    { 闭包 }
  闭包:
    条目 [ '*' | '+' | '?' ]
  条目:
    '^'
    '$'
    '.'
    字符
    '[' [ '^' ] 字符遍历 ']'
    '(' 正则表达式 ')'
*/
package regexp
// path 包实现了一些常用的工具，以便于操作用反斜杠分隔的路径.

// 表达式解析失败后返回错误代码。
var (
  ErrInternal      = errors.New("regexp: internal error")
  ErrUnmatchedLpar = errors.New("regexp: unmatched '('")
  ErrUnmatchedRpar = errors.New("regexp: unmatched ')'")
  // ...
)
```


go.md

一个多行文档字符串的例子

```python
def my_function():
    """Do nothing, but document it.

    No, really, it doesn't do anything.
    """
    pass

print(my_function.__doc__)
```

```sh
Do nothing, but document it.

    No, really, it doesn't do anything.
```


python.md

## 文档注释

`//!` 通常用于 crate 根文件（通常是 `src/lib.rs`）或模块的根文件，为 crate 或模块整体提供文档。

````rust
/// Adds one to the number given.
///
/// # Examples
///
/// ```
/// let arg = 5;
/// let answer = my_crate::add_one(arg);
///
/// assert_eq!(6, answer);
/// ```
pub fn add_one(x: i32) -> i32 {
    x + 1
}


//! # My Crate
//!
//! `my_crate` is a collection of utilities to make performing certain
//! calculations more convenient.

/// Adds one to the number given.
// --snip--
````
