public class ConstructorTooLong extends Comment

This comment indicates that the code in the solution's constructor is too long, and that it would benefit from being broken up into helper methods.

See Also:

• Markdown Template

• Nested Class Summary

• Constructor Summary

  Constructors

• Method Summary

  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()

• Constructor Details

  • ConstructorTooLong

  • ConstructorTooLong

    public ConstructorTooLong(String constructorName)

• Method Details

  • getKey

    Description copied from class: Comment

    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.

    Specified by:

    getKey in class Comment

    Returns:

    The unique comment key.

  • getParameters

    Description copied from class: Comment

    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");
         }
     

    Overrides:

    getParameters in class Comment

    Returns:

    The parameters for the comment.

  • getType

    Description copied from class: Comment

    • 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.

    Overrides:

    getType in class Comment

    Returns:

    The type of the comment.

    See Also:

    • Documentation on comment types