什么是文档中的C（参数）

Question

最近我一直在审查很多Ansible模块（代码），并且在引用诸如下面的示例（F5 modules）之类的参数时，我在文档部分遇到了一些奇怪的命名法：

  指定

，将使用 C（循环）的默认值

或者

  

如果此值是IP地址， C（类型）是 C（tcp）（   默认），           然后必须指定 C（端口）号码。

什么是 C ，在记录代码时是否需要？正如我所说，并非所有模块都包含在其中。

Answer 1

我刚在ansible.docs-1.7.pdf ^1），第545页找到了这个：

  

description和notes字段支持格式化   特殊的宏。

     

这些格式化功能包括U()，M()，I()和C()的网址，   模块，斜体和恒定宽度。有人建议   使用C()表示文件和选项名称，并在引用时使用I()   参数;模块名称应指定为M(module)。

^1）这似乎有些过时，但应该仍然有效。同样也可以在latest online documentation中找到。