template_doc.md

{{ function.name }}

---

{{ function.short_description }}

语法

{% for name in usage.outputs %}{{ name.name }}, {% endfor %}= {{ function.name }}({% for name in usage.inputs %}{{ name.name }}, {% endfor %}){% endfor %}

说明

{% for usage in usages %} {% for name in usage.outputs %}[{{ name.name }}](/Doc/{{ tool_box }}/{{ class }}/{{ sub_class }}/{{ function.name }}.html#{{ name.name }}), {% endfor %}= {{ function.name }}({% for name in usage.inputs %}[{{ name.name }}](/Doc/{{ tool_box }}/{{ class }}/{{ sub_class }}/{{ function.name }}.html#{% if name.name=="Name=Value"%}{{ "名称-值对组参数" }}{% elif name.name=="____" %}{{ "输入参数" }}{% else %}{{ name.name }}{% endif %}), {% endfor %}) {{ usage.usage }}

---

{% endfor %}

示例

{% for example in examples %}

{{ example.name }}

示例内容，使用 Markdown 格式文本进行编写。

{% endfor %}

输入参数

{% for arg in inputs %}

{{ arg.arg }} - {{ arg.short_description }}

{{ arg.type_zh }}

{{ arg.long_description }}

数据类型: {{ arg.type }}

{% endfor %} {% if name_value %} ### 名称-值对组参数

指定可选的、以逗号分隔的 Key=Value 对组参数。Key 为参数名称，Value 为对应的值。您可采用任意顺序指定多个名称-值对组参数，如 Key1=Value1,...,KeyN=ValueN 所示。

示例：

{% for arg in name_value %}

{{ arg.arg }} - {{ arg.short_description }}

{{ arg.default}} （默认） | {{ arg.type_zh }}

{{ arg.long_description }}

数据类型: {{ arg.type }}

{% endfor %} {% endif %}

输出参数

{% for arg in outputs %}

{{ arg.arg }} - {{ arg.short_description }}

{{ arg.type_zh }}

{{ arg.long_description }}

{% endfor %}