Direct Known Subclasses:

AvoidBooleanLiteralReturns, AvoidComparisonWithLiteral, AvoidHardCodedTestCases, AvoidIfStatements, AvoidPrintStatements, ConstructorTooLong, DoNotUseMainMethod, ExemplarSolution, FeedbackRequest, MethodTooLong, PreferStringConcatenation, RedundantParentheses, RemoveTodoComments, ReuseCode, ReuseCodeFromDescribeThreeParams, ReuseCodeFromDescribeTwoParams, UseNullLiteral

public abstract class Comment extends Object

See Also:

• The analyzer interface in the Exercism documentation
• Analyzer comments for the Java track in the website-copy

• Nested Class Summary

  Nested Classes

• Constructor Summary

  Constructors

• Method Summary

  boolean

  boolean

  getKey()

  The comment key is a String that uniquely identifies the comment.

  Each parameter in the Markdown template should have a corresponding parameter in the comment.

  getType()

  int

  hashCode()

  toString()

• Constructor Details

  • Comment

    public Comment()

• Method Details

  • getKey

    public abstract String getKey()

    The comment key is a String that uniquely identifies the comment.

    Comment keys use the format "java.<scope>.<name>". The <scope> can be either general for general comments, or the slug of the exercise for exercise-specific comments. The <name> specifies the name of the comment.

    The combination of <scope> and <name> must be unique, and defines the location of the Markdown template in the exercism/website-copy repository.

    For example, the comment key "java.hello-world.foo_bar" would translate to the Markdown file at analyzer-comments/java/hello-world/foo_bar.md.

    Returns:

    The unique comment key.

  • getParameters

    Each parameter in the Markdown template should have a corresponding parameter in the comment. Parameters in Markdown templates are of the form %<parameterName>s.

    For example, if the Markdown template contains a parameter %<methodName>s, the implementation of this method could look like this:

    
         public Map<String, String> getParameters() {
             return Map.of("methodName", "theNameOfTheMethod");
         }
     

    Returns:

    The parameters for the comment.

  • getType

    • Use Comment.Type.ESSENTIAL to instruct students that they must address it.
    • Use Comment.Type.ACTIONABLE to instruct students that they could improve their solution by addressing it.
    • Use Comment.Type.INFORMATIVE to give students extra information without expecting them to use it.
    • Use Comment.Type.CELEBRATORY to tell students that they did something right.

    Returns:

    The type of the comment.

    See Also:

    • Documentation on comment types

  • equals

    public boolean equals(Object obj)

    Overrides:

    equals in class Object

  • hashCode

    public int hashCode()

    Overrides:

    hashCode in class Object

  • toString

    Overrides:

    toString in class Object