Package com.tngtech.jgiven.annotation

Annotation Type StepComment

@Documented
@Retention(RUNTIME)
@Target(METHOD)
public @interface StepComment

Marks a method to be used to provide an additional comment to the previous step. This optional comment can be used by reporters for the output. A step comment is intended to provide additional information about a specific step invocation, e.g., because it might be surprising that the step is required. If you want to provide a more detailed description of a step method in general, refer to ExtendedDescription. A method decorated with this annotation is expected to take exactly one argument of type String.

Since:

0.12.0