Jinja2 内联注释

2022-01-11 00:00:00 python jinja2 comments macros

问题描述

如何在 Jinja2 参数列表声明中添加注释?

How can I put comments inside Jinja2 argument list declaration ?

我尝试过的一切都会出错:jinja2.exceptions.TemplateSyntaxError: unexpected char u'#'

Everything I have tried gives an error: jinja2.exceptions.TemplateSyntaxError: unexpected char u'#'

{{ Switch('var',
    [('1', 'foo'),    #  comment 1
     ('2', 'bar'),    ## comment 2
     ('3', 'rum'),    {# comment 3 #}
     ]) }}


{% macro Switch(var, caselist) %}
    {% for case, action in caselist%}
        CMP  {{var}} {{case}} 
        JNE  {{LABEL}}
        {{action}}
        JMP  {{LABELF}}
{{LABEL}}:  NOP
    {%- endfor %}
{{LABELF}}: NOP
{%- endmacro -%}

在我的例子中，Jinja2 被用作汇编程序的宏预处理器.

In my case Jinja2 is used as macro preprocessor for assembler.

解决方案

Jinja2 不支持 {{ ... }} 语句中的注释.您只能在此类语句的外部使用注释，然后只能使用 {# .. #} 或 ## comment.

Jinja2 has no support for comments within a {{ ... }} statement. You can only use comments outside of such statements, and then only with {# .. #} or ## comment.

  • {# .. #} 仅用于禁用模板的一部分或在其他 Jinja2 语法之外添加注释.你不能嵌套这些.
  • # statement 等价于 {% statement %}，如果 行语句已启用并进行配置.
  • ## comment 仅在启用 line 语句时才有效，此时它被视为注释.
  • {# .. #} is only meant for disabling part of a template or adding comments outside of other Jinja2 syntax. You can't nest these.
  • # statement is the equivalent of {% statement %}, if line statements are enabled and so configured.
  • ## comment only works if line statements are enabled, at which point it regarded as a comment.

通常，在 Jinja 语句之外，使用目标语言的注释来代替；例如 生成XML时等

Generally, outside of Jinja statements, use comments in the target language instead; e.g. <!-- comment --> when generating XML, etc.

相关文章