CsvExport 项目使用教程

1. 项目目录结构及介绍

CsvExport 项目是一个简单的 C# 开源库，用于导出 CSV 文件。项目的目录结构如下：

CsvExport/
├── .github/              # GitHub 工作流目录
│   ├── workflows/
│   │   ├── CsvExport.yml
│   │   └── SpeedBenchmarks.yml
├── CsvExport/            # CsvExport 库的源代码
│   ├── CsvExport.cs
│   └── CsvExport_Typed.cs
├── SpeedBenchmarks/      # 性能测试代码
├── UnitTests/            # 单元测试代码
├── .gitignore            # Git 忽略文件
├── CsvExport.sln         # 解决方案文件
├── LICENSE              # 许可证文件
└── README.md            # 项目说明文件

• .github/: 包含 GitHub Actions 工作流文件，用于自动化项目的某些任务。
• CsvExport/: 包含CsvExport库的核心代码。
• SpeedBenchmarks/: 包含性能测试的代码。
• UnitTests/: 包含项目的单元测试代码。
• .gitignore: 指定 Git 忽略的文件和目录。
• CsvExport.sln: Visual Studio 解决方案文件，用于管理项目。
• LICENSE: 项目使用的 MIT 许可证。
• README.md: 项目说明文件，介绍项目的相关信息。

2. 项目的启动文件介绍

CsvExport 项目作为一个库，没有直接的启动文件。它被设计为可以被其他 C# 项目引用。若要使用 CsvExport，通常需要通过 NuGet 包管理器安装它：

Install-Package CsvExport

安装后，你可以在你的 C# 项目中引用 CsvExport 并使用它来导出 CSV 文件。

下面是一个简单的使用示例：

var myExport = new CsvExport();
myExport.AddRow();
myExport["Region"] = "Los Angeles, USA";
myExport["Sales"] = 100000;
myExport["Date Opened"] = new DateTime(2003, 12, 31);
myExport.AddRow();
myExport["Region"] = "Canberra in Australia";
myExport["Sales"] = 50000;
myExport["Date Opened"] = new DateTime(2005, 1, 1, 9, 30, 0);

return File(myExport.ExportAsMemoryStream(), "text/csv", "results.csv");

3. 项目的配置文件介绍

CsvExport 项目自身不包含特定的配置文件。所有配置都是通过 CsvExport 类的构造函数参数来设置的。下面是一个配置 CsvExport 类的示例：

var myExport = new CsvExport(
    columnSeparator: ",",
    includeColumnSeparatorDefinitionPreamble: true,
    includeHeaderRow: true
);

• columnSeparator: 设置列分隔符，默认为逗号。
• includeColumnSeparatorDefinitionPreamble: 如果 Excel 需要列分隔符定义的前缀，则设置为 true。
• includeHeaderRow: 设置是否包含表头行。

如果需要导出到文件或使用特定编码，可以使用 ExportToFile、ExportAsMemoryStream 或 ExportToBytes 方法，并提供相应的编码参数。