Skip to content

docs: 更新 README 文档#11

Merged
CPythoner merged 2 commits intomasterfrom
docs/update-readme
Apr 3, 2026
Merged

docs: 更新 README 文档#11
CPythoner merged 2 commits intomasterfrom
docs/update-readme

Conversation

@CPythoner
Copy link
Copy Markdown
Owner

更新内容

主要改进

  • 添加 CI 状态徽章,显示构建状态
  • 更新代码示例以匹配当前实现
  • 添加完整的 API 参考表格
  • 添加构建与测试说明
  • 添加注意事项说明拷贝控制和内存对齐

删除内容

  • 删除了过时的 Java 版本对比说明
  • 删除了冗余的图片链接(使用文字描述替代)
  • 简化了结构,使其更易于阅读

新增内容

  • 快速开始指南
  • 完整的 API 参考表格
  • 构建与测试说明
  • 注意事项(拷贝控制、内存对齐、字节序)

- 禁用拷贝构造函数和赋值运算符,防止双重释放
- 添加移动构造函数和移动赋值运算符
- 使用 constexpr 替代宏定义 DEFAULT_BUFFER_SIZE
- 使用 nullptr 替代 NULL
- 使用 reinterpret_cast 替代 C 风格转换
- 移除构造函数中重复的 p_buffer_ 初始化
- 添加 <cstring> 头文件
- 添加 hasRemaining() const 修饰符
- 添加 CI 状态徽章
- 更新代码示例以匹配当前实现
- 添加完整的 API 参考表格
- 添加构建与测试说明
- 添加注意事项说明拷贝控制和内存对齐
@CPythoner CPythoner merged commit b4e9f81 into master Apr 3, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant