elasticsearch/docs/reference/scripting-languages/painless/painless-comments.md
Colleen McGinnis b7e3a1e14b
[docs] Migrate docs from AsciiDoc to Markdown (#123507)
* delete asciidoc files

* add migrated files

* fix errors

* Disable docs tests

* Clarify release notes page titles

* Revert "Clarify release notes page titles"

This reverts commit 8be688648d.

* Comment out edternal URI images

* Clean up query languages landing pages, link to conceptual docs

* Add .md to url

* Fixes inference processor nesting.

---------

Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Martijn Laarman <Mpdreamz@gmail.com>
Co-authored-by: István Zoltán Szabó <szabosteve@gmail.com>
2025-02-27 17:56:14 +01:00

1.2 KiB

mapped_pages
https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-comments.html

Comments [painless-comments]

Use a comment to annotate or explain code within a script. Use the // token anywhere on a line to specify a single-line comment. All characters from the // token to the end of the line are ignored. Use an opening /* token and a closing */ token to specify a multi-line comment. Multi-line comments can start anywhere on a line, and all characters in between the /* token and */ token are ignored. A comment is included anywhere within a script.

Grammar

SINGLE_LINE_COMMENT: '//' .*? [\n\r];
MULTI_LINE_COMMENT: '/*' .*? '*/';

Examples

  • Single-line comments.

    // single-line comment
    
    int value; // single-line comment
    
  • Multi-line comments.

    /* multi-
       line
       comment */
    
    int value; /* multi-
                  line
                  comment */ value = 0;
    
    int value; /* multi-line
                  comment */
    
    /* multi-line
       comment */ int value;
    
    int value; /* multi-line
                  comment */ value = 0;
    
    int value; /* multi-line comment */ value = 0;