Package analyzer.comments

Class FeedbackRequest

java.lang.Object

analyzer.Comment

analyzer.comments.FeedbackRequest

public class FeedbackRequest
extends Comment

This comment requests students to leave feedback on the analyzer comments. Use it whenever new comments or analyzers are implemented, as a way to "beta-test" the new functionality.

See Also:

• Markdown Template

Nested Class Summary

Nested classes/interfaces inherited from class analyzer.Comment

Comment.Type

Constructor Summary

Constructors

Constructor	Description
FeedbackRequest()

Method Summary

Modifier and Type	Method	Description
String	getKey()	The comment key is a String that uniquely identifies the comment.

Methods inherited from class analyzer.Comment

equals, equals, getParameters, getType, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Details

FeedbackRequest

public FeedbackRequest()

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.