RFR: 8267570: The comment of the class JavacParser is not appropriate

[Jonathan Gibbons]

On Sat, 22 May 2021 13:51:10 GMT, Guoxiong Li <gli at openjdk.org> wrote:

> Hi all,
> 
> The following comment of the class JavacParser is not appropriate.
> 
> 
> It operates by recursive descent, with code derived
> systematically from an LL(1) grammar.
> 
> 
> From the source code, the current javac parser looks like a LL(K) parser instead of LL(1).
> This patch revises the comment so that developers won't be confused by it.
> 
> Thank you for taking the time to review.
> 
> Best Regards,
> -- Guoxiong

Changes requested by jjg (Reviewer).

src/jdk.compiler/share/classes/com/sun/tools/javac/parser/JavacParser.java line 68:

> 66:  * The parser maps a token sequence into an abstract syntax tree.
> 67:  * The current javac parser is a hand-written recursive-descent parser.
> 68:  * It implements the grammar described in the Java Language Specification.

In general, temporal words (like "current") should be avoided as a matter of style.

I suggest:

The parser is a hand-written recursive-descent parser that
implements the grammar described in the Java Language Specification.

-------------

PR: https://git.openjdk.java.net/jdk/pull/4153