ansible.builtin.comment 过滤器 – 将字符串注释化

注意

此过滤器插件是 ansible-core 的一部分，包含在所有 Ansible 安装中。在大多数情况下，您可以使用简短的插件名称 comment。但是，我们建议您使用完全限定的集合名称 (FQCN) ansible.builtin.comment，以便轻松链接到插件文档并避免与可能具有相同过滤器插件名称的其他集合冲突。

概要

  • 使用编程语言约定将输入字符串转换为可嵌入的注释。

输入

此部分描述过滤器的输入，即 | ansible.builtin.comment 之前的数值。

参数

注释

输入

字符串 / 必需

要注释的字符串。

位置参数

此部分描述过滤器的定位参数。这些是在以下示例中的 positional1、positional2 等值：input | ansible.builtin.comment(positional1, positional2, ...)

参数

注释

样式

字符串

要使用的注释样式。

选项

  • "plain" ← (默认)

  • "decoration"

  • "erlang"

  • "c"

  • "cblock"

  • "xml"

关键字参数

此部分描述过滤器的关键字参数。这些是在以下示例中的 key1=value1、key2=value2 等值：input | ansible.builtin.comment(key1=value1, key2=value2, ...)

参数

注释

开头

字符串

注释块的开始指示符，仅适用于支持多行注释的样式。

装饰

字符串

根据样式指示注释或中间注释。

结尾

字符串

注释块结尾的指示符，仅适用于支持多行注释的样式。

换行符

字符串

注释行尾的指示符，仅适用于支持多行注释的样式。

默认值： "\\n"

后缀

字符串

注释块内每一行结尾的指示符，仅适用于支持多行注释的样式。

后缀计数

整数

当存在且可使用前缀时，在行尾添加后缀的次数。

默认值： 1

前缀

字符串

注释块内每一行开始的标记，仅适用于支持多行注释的样式。

前缀计数

整数

当存在且可使用前缀时，在行首添加前缀的次数。

默认值： 1

注释

注意

  • 当同时使用关键字参数和位置参数时，位置参数必须列在关键字参数之前：input | ansible.builtin.comment(positional1, positional2, key1=value1, key2=value2)

示例

# commented =>  #
#               # Plain style (default)
#               #
commented: "{{ 'Plain style (default)' | comment }}"

# not going to show that here ...
verycustom: "{{ "Custom style" | comment('plain', prefix='#######\n#', postfix='#\n#######\n   ###\n    #') }}"

返回值

键

描述

返回值

字符串

“已注释”的字符串。

返回：成功

提示

每种条目类型的配置条目具有从低到高的优先级顺序。例如，列表中较低的变量将覆盖较高的变量。