All classes and all public methods should have javadocs.  Period.  That should be the main reason.  Informal code comments using // or /*...*/ are not a replacement for javadoc.

Grigore


________________________________
From: dwightguth [notifications@github.com]
Sent: Friday, March 28, 2014 4:16 PM
To: kframework/k
Subject: Re: [k] Newparser firstdraft (#318)


In src/javasources/KTool/src/org/kframework/parser/concrete2/Rule.java:

> +        public final int startColumn;
> +        public final int endPosition;
> +        public final int endLine;
> +        public final int endColumn;
> +        public MetaData(int startPosition, int startLine, int startColumn, int endPosition, int endLine, int endColumn) {
> +            this.startPosition = startPosition; this.startLine = startLine; this.startColumn = startColumn;
> +            this.endPosition = endPosition; this.endLine = endLine; this.endColumn = endColumn;
> +        }
> +    }
> +
> +    public static abstract class ContextFreeRule extends Rule {
> +        public abstract Set<KList> apply(Set<KList> set, MetaData metaData);
> +    }
> +
> +    // helper class for rules that treat each KList separately
> +    public static abstract class KListRule extends ContextFreeRule {


Again I feel obliged to point out that the reason I'm asking for a javadoc is because the comment that's there doesn't tell me anything actually meaningful. I will have a set of comments at the end of this review once I'm finished dealing with general themes. I suggest you read it carefully.

—
Reply to this email directly or view it on GitHub<https://github.com/kframework/k/pull/318/files#r11086006>.