Raku 编程/注释和 POD

Raku 编程

注释

现在我们已经涵盖了 Raku 编程的大部分基础知识。我们并没有完全涵盖这门语言。但是，我们已经看到了普通编程任务所需的各种基本工具。还有更多内容需要学习，许多高级工具和功能可以用来简化常见任务，以及使困难的任务成为可能。我们将在稍后介绍一些这些更高级的功能，但在本章中，我们想通过讨论注释和文档来结束“基础”部分。

我们之前提到过，注释是在源代码中供程序员阅读的笔记，Raku 解释器会忽略这些笔记。Raku 中最常见的注释形式是单行注释，以单个井号 # 开头，一直延伸到行尾。

# Calculate factorial of a number using recursion
sub factorial (Int $n) {
    return 1 if $n == 0;            # This is the base case
    return $n * factorial($n - 1);  # This is the recursive call
}

当执行上述代码时，所有以单个井号 # 为前缀的文本将被 Raku 解释器忽略。

多行注释

虽然 Perl 不提供多行注释，但 Raku 提供。为了在 Raku 中创建多行注释，注释必须以单个井号开头，后面跟着一个反引号，然后是一些打开的括号字符，最后以匹配的关闭括号字符结尾。

sub factorial(Int $n) {
    #`( This function returns the factorial of a given parameter
      which must be an integer. This is an example of a recursive
      function where there is a base case to be reached through
      recursive calls.
      )
    
    return 1 if $n == 0;            # This is the base case
    return $n * factorial($n - 1);  # This is the recursive call
}

此外，注释的内容也可以嵌入在内联中。

sub add(Int $a, Int $b) #`( two (integer) arguments must be passed! ) {
    return $a + $b;
}

POD 文档