From e785c00f16b14c41eb1cbb4362157dc23f4c4e50 Mon Sep 17 00:00:00 2001
From: Gary Gregory <garydgregory@gmail.com>
Date: Fri, 25 Aug 2023 07:14:35 -0400
Subject: [PATCH] Javadoc

---
 src/main/java/org/apache/commons/csv/CSVFormat.java | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java b/src/main/java/org/apache/commons/csv/CSVFormat.java
index 275c0dae..d1db876e 100644
--- a/src/main/java/org/apache/commons/csv/CSVFormat.java
+++ b/src/main/java/org/apache/commons/csv/CSVFormat.java
@@ -1524,6 +1524,19 @@ public final class CSVFormat implements Serializable {
 
     /**
      * 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}
      */