FAQ zh CN

常见问题

本页面回答一些关于 cfstream 的项目级常见问题。

cfstream 是什么？

cfstream 是一个轻量级的 C/C++ header-only 库，旨在让文件输入输出操作和重定向更加简单。

它提供了简单的接口，用于重定向标准输入输出、使用独立的 C++ 文件流，以及查询当前库版本。

简单来说，cfstream 是一个用于 C 和 C++ 项目的小型辅助库，适合本地基于文件的测试和简单的文件 I/O 重定向场景。

cfstream 适合哪些人使用？

cfstream 适合需要简单处理文件输入输出的 C 和 C++ 用户。

它可能适合学生、初学者、信息学奥赛（OI）学习者、算法竞赛用户，以及开发小型 C/C++ 项目的开发者。

它尤其适合本地测试、调试，以及只需要一个轻量级辅助工具的文件输入输出场景。

我应该包含哪个头文件？

在现代 cfstream 用法中，请根据你使用的语言选择对应的头文件：

语言	推荐头文件
C++	cfs.hpp
C	cfs.h

如果你正在编写 C++ 项目，通常应该使用：

#include "cfs.hpp"

如果你正在编写 C 项目，应该使用：

#include "cfs.h"

C 头文件 cfs.h 也可以为了兼容性被包含在 C++ 代码中，但不推荐在普通 C++ 项目中这样使用。

在 C++ 项目中，cfs.h 只提供类似于 cfs.hpp 中标准流重定向的功能。它不提供基于 C++ 命名空间的接口，也不提供独立的 cfs::cin / cfs::cout 文件流。

由于 cfs.h 不使用 cfs 命名空间，因此它也可能在 C++ 项目中造成命名冲突。

对于 C++ 用户，除非你确实需要兼容 C 风格接口，否则应优先使用 cfs.hpp。

如何反馈 bug 或建议？

你可以通过在 GitHub 仓库中创建 issue 来反馈 bug、错误或建议。

如果你更希望直接联系我，也可以发送邮件至：

3595864179@qq.com

反馈 bug 时，请尽量清楚地描述问题，并附上有用的信息，例如你的操作系统、编译器、cfstream 版本，以及尽可能小的复现示例。

如何参与项目合作？

你可以通过多种方式参与这个项目。

你可以 fork 仓库，进行修改，然后提交 pull request。欢迎提交 pull request，但它们会在合并前经过审核。

你也可以通过改进文档、反馈 bug、提出新功能建议或分享你的想法来帮助项目。

如果你更希望直接联系我，可以发送邮件至：

3595864179@qq.com

我可以自由使用这份代码吗？

可以。cfstream 使用 MIT License 发布，因此你可以在自己的项目中使用、复制、修改、合并、发布、分发、再授权和使用这份代码，包括商业项目。

不过，在重新分发代码时，你必须保留原始版权声明和 MIT License 许可声明。

代码按“原样”提供，不附带任何担保。作者不对使用该代码造成的任何问题负责。

如何支持这个项目？

你可以通过在 GitHub 上给项目点 star、推荐给其他用户，或在自己的项目中公开使用它来支持这个项目。

如果 cfstream 对你有帮助，把它分享给其他人也是支持项目的好方法。

欢迎给与反馈、建议和真实项目中的使用案例。