Interface CodeBlockComment

All Superinterfaces:

CodeComment, CodeItem, CodeItemWithVariables, CodeStatement, Iterable<String>

public interface CodeBlockComment
extends CodeComment

CodeComment representing a multi-line comment. Example

/*
 * This is the first line of the comment.
 * There can also be more lines.
 */

Since:

1.0.0

Author:

hohwille

Field Summary

Fields inherited from interface CodeItem

DEFAULT_INDENT, DEFAULT_NEWLINE

Method Summary

Modifier and Type	Method	Description
List<String>	getCommentLines()

Methods inherited from interface CodeComment

getVariable, iterator

Methods inherited from interface CodeItem

getLanguage, getSourceCode, write, write, write, write, write, write

Methods inherited from interface Iterable

forEach, spliterator

Method Details

getCommentLines

List<String> getCommentLines()

Specified by:

getCommentLines in interface CodeComment

Returns:

the List of comment lines. Will always have the size 1 in case of CodeSingleLineComment. Each contained String will be the pure comment without leading comment prefix ("// ", "/* ", etc.).