Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8284038

Update JEP and spec to clarify that tags like // @start is inclusive of the line it is on

    XMLWordPrintable

    Details

      Description

      It is not clear in the specification that tags like // @start is inclusive of the line it is defined on.

      https://docs.oracle.com/en/java/javase/18/docs/specs/javadoc/doc-comment-spec.html

      e.g.

      public void myMethod() // @start region="my-region"
      ...

      Would include "public void myMethod()" in the "my-region" region. Intuitively the tag must be placed on the line before, which can also lead to some confusing issues, like extra lines when using hybrid-snippets.

        Attachments

          Activity

            People

            Assignee:
            prappo Pavel Rappo
            Reporter:
            bkorando Billy Korando
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated: