Go encoding/csv Comment Comment 设置为空字符时如何恢复普通文本

读取同一份 CSV 时，配置文件有时把以 # 开头的行当成注释，有时又要求把它们当作普通文本保存。Go 的 encoding/csv 不需要更换解析器：在第一次调用 Read 或 ReadAll 之前，把 Reader.Comment 设为 0，就能关闭注释行过滤。此时 # 会留在字段内容里，再由 Comma 规则决定字段如何拆分。

把 Comment 设为 0，原注释行就会回到普通记录

Reader.Comment 的语义是“非零时使用哪个字符识别注释行”。例如设置为 '#' 时，行首紧接着出现 # 的整行会被忽略；设置为 0 时，这条过滤规则关闭。这里的“普通文本”不是特殊的数据类型，而是重新进入 CSV 的正常记录解析过程。

下面的封装把配置动作放在读取循环之前。代码没有运行任何外部命令，重点是展示配置时机和错误边界：

package main

import (
    "encoding/csv"
    "fmt"
    "io"
    "strings"
)

func readCSV(text string, keepHashLine bool) error {
    r := csv.NewReader(strings.NewReader(text))

    // 配置必须在第一次 Read 前完成；0 表示关闭注释过滤。
    if keepHashLine {
        r.Comment = 0
    } else {
        r.Comment = '#'
    }

    for {
        record, err := r.Read()
        if err == io.EOF {
            break
        }
        if err != nil {
            // 解析错误要返回给调用方，不能把坏记录静默当成普通文本。
            return fmt.Errorf("读取 CSV 失败: %w", err)
        }
        fmt.Println(record)
    }
    return nil
}

func main() {
    input := "#保留的说明,10\\n正常记录,20\\n"
    // true：把 # 开头的行作为普通记录保留下来。
    _ = readCSV(input, true)
}

动态切换时，真正的边界是第一次读取之前

很多“设置了但没有生效”的问题，不在 Comment 的值，而在修改时机。官方文档允许导出的 Reader 配置字段在首次 Read 或 ReadAll 前调整。一个 Reader 一旦开始消费输入，就不适合再拿来切换另一套格式约定。

因此，按配置读取多个文件时，应该让每个输入流都重新创建 Reader：

func newReader(text string, comment rune) *csv.Reader {
    r := csv.NewReader(strings.NewReader(text))

    // comment 为 0 时恢复普通文本；非零时启用对应注释字符。
    r.Comment = comment
    return r
}

// 使用方式：先建立 Reader 并配置，再调用 ReadAll。
r := newReader("#文本,1\\n数据,2\\n", 0)
records, err := r.ReadAll()
if err != nil {
    fmt.Println("读取失败:", err)
}
fmt.Println(records)

若代码已经调用过一次 Read，再写 r.Comment = 0，不要把后续结果当成“动态切换已完整生效”的证明。工程上更稳妥的做法是保存原始输入位置，或者直接为这次格式选择重新创建 Reader。

四个容易把普通文本误判成注释的细节

前导空白会改变注释判断

当 Comment 为 '#' 时，只有行首直接是 # 才会被忽略。前面有空格的 #文本 不满足这个条件，# 会进入字段内容；TrimLeadingSpace 也不会把它重新变成注释行。

0 不是合法的“注释字符”

零值在 Reader 中承担的是禁用开关。若从配置文件读到空字符串，应先把它解释为“未启用注释”，不要把空字符串转换为一个业务自定义字符。真正启用注释时，字符必须是有效 rune，不能是换行、Unicode replacement character，也不能和 Comma 相同。

关闭注释过滤不会关闭 CSV 语法

Comment = 0 只影响注释行过滤。引号字段里的逗号、字段数校验、空行忽略以及非法引号仍按 CSV Reader 的规则处理。若 #文本,10 解析失败，应先看分隔符、引号和字段数，不要继续修改 Comment。

相关问题

把 Comment 设成逗号可以吗？

不可以。Comment 不能与 Comma 相同；需要关闭注释时使用零值，需要启用注释时选择独立且有效的 rune。

ReadAll 之前可以修改 Comment 吗？

可以，但必须早于第一次读取。创建 Reader 后先完成全部字段配置，再调用 ReadAll。

为什么带空格的井号行没有被跳过？

因为注释字符前存在空白时，它会被当作字段内容的一部分；这与是否设置 TrimLeadingSpace 是两回事。

落地时可以把规则记成一句话：需要保留井号开头行，就在创建 Reader 后、第一次读取前写 r.Comment = 0；遇到解析错误，再分别检查输入格式和字段约束。