Package analyzer.comments

Class ReuseCode

java.lang.Object

analyzer.Comment

analyzer.comments.ReuseCode

public class ReuseCode
extends Comment

See Also:

• Markdown Template

Nested Class Summary

Nested classes/interfaces inherited from class analyzer.Comment

Comment.Type

Constructor Summary

Constructors

Constructor	Description
ReuseCode(String callingMethod, String methodToCall)

Method Summary

Modifier and Type	Method	Description
String	getKey()	The comment key is a String that uniquely identifies the comment.
Map<String,String>	getParameters()	Each parameter in the Markdown template should have a corresponding parameter in the comment.
Comment.Type	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.

Methods inherited from class analyzer.Comment

equals, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ReuseCode

public ReuseCode(String callingMethod,
 String methodToCall)

Method Details

getKey

public String 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

public Map<String,String> 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

public Comment.Type 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