Interface CodeComments

All Superinterfaces:

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

public interface CodeComments
extends CodeComment

CodeComment representing a sequence of CodeComments. Example:

// This is a single-line comment
// Yet another single-line comment
/* This is a multi-line comment with only a single line */
// Again a single-line comment
/*
 * And again multi-line
 * comment follows.
 */

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<? extends CodeComment>	getCommentBlocks()

Methods inherited from interface CodeComment

getCommentLines, getVariable, iterator

Methods inherited from interface CodeItem

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

Methods inherited from interface Iterable

forEach, spliterator

Method Details

getCommentBlocks

List<? extends CodeComment> getCommentBlocks()

Returns:

the List with the CodeComments.