CSV-84 Clarify comment handling

Document how comment behaves

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1306316 13f79535-47bb-0310-9956-ffa450edef68

Author: sebbASF

src/main/java/org/apache/commons/csv/CSVFormat.java

@@ -264,6 +264,9 @@ public char getCommentStart() {
     /**
      * Returns a copy of this format using the specified character as the comment start marker.
      * 
+     * Note that the comment introducer character is only recognised
+     * at the start of a line.
+     * 
      * @param commentStart the comment start marker
      * @return A copy of this format using the specified character as the comment start marker
      * @throws IllegalArgumentException thrown if the specified character is a line break
@@ -279,6 +282,9 @@ public CSVFormat withCommentStart(char commentStart) {
     /**
      * Specifies whether comments are supported by this format.
      * 
+     * Note that the comment introducer character is only recognised
+     * at the start of a line.
+     * 
      * @return <tt>true</tt> is comments are supported, <tt>false</tt> otherwise
      */
     public boolean isCommentingEnabled() {