docs: update containers API docs

This commit is contained in:
2026-03-20 02:35:01 +08:00
parent a647f5e8ec
commit 0c073db4e8
33 changed files with 135 additions and 56 deletions

View File

@@ -7,11 +7,11 @@ Array(size_t count, const T& value);
Array(std::initializer_list<T> init);
```
构造一个 `Array<T>` 实例。
构造一个 `template<typename T> XCEngine::Containers::Array<T>` 实例。
**默认构造**:构造空数组,不分配内存。
**默认构造**:构造空数组,不分配内存。数组初始为空容量为0。
**容量构造**:预分配指定容量的内存,但不设置元素数量。适用于已知大致元素数量时减少重新分配。
**容量构造explicit**:预分配指定容量的内存,但不设置元素数量。适用于已知大致元素数量时减少重新分配。
**数量构造**:创建 `count` 个元素,每个元素都是 `value` 的拷贝。使用拷贝构造,不调用默认构造。
@@ -23,20 +23,26 @@ Array(std::initializer_list<T> init);
- `value` - 每个元素的初始值
- `init` - initializer_list 初始化列表
**注意:** `Array(size_t capacity)` 是 explicit 的,防止隐式转换。
**示例:**
```cpp
#include <XCEngine/Containers/Array.h>
using namespace XCEngine::Containers;
// 默认构造
Containers::Array<int> arr1;
Array<int> arr1;
// 预分配容量(不设置元素)
Containers::Array<int> arr2(100);
Array<int> arr2(100);
// 创建 10 个元素,初始值为 42
Containers::Array<int> arr3(10, 42);
Array<int> arr3(10, 42);
// 使用 initializer_list
Containers::Array<int> arr4 = {1, 2, 3, 4, 5};
Array<int> arr4 = {1, 2, 3, 4, 5};
```
## 相关文档