Apache
/
commons-csv
mirror of https://github.com/apache/commons-csv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Javadoc

This commit is contained in:
Gary Gregory 2023-08-25 07:14:35 -04:00
parent 9668d4628e
commit e785c00f16
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/main/java/org/apache/commons/csv/CSVFormat.java
View File

@ -1524,6 +1524,19 @@ public final class CSVFormat implements Serializable {
/** /**
* Gets the character marking the start of a line comment. * Gets the character marking the start of a line comment.
* <p>
* The comment format for each line is:
* </p>
* <pre>
* CommentMarker SPACE CommentArrayElement
* </pre>
* <p>
* For example, using a comment marker {@code '#'} and a comment array {@code comments ["line 1", "line 2"]}:
* </p>
* <pre>
* # line 1
* # line 2
* </pre>
* *
* @return the comment start marker, may be {@code null} * @return the comment start marker, may be {@code null}
*/ */