更新 README.md

- 添加项目说明
- 添加 fibonacci 模块使用文档
- 添加示例和 API 说明
This commit is contained in:
芊荨
2026-04-02 14:44:59 +08:00
parent d6a34e8847
commit f6e8cf0429

View File

@@ -1,2 +1,50 @@
readme
check name
# Code Repository
代码仓库 - 芊荨
## 项目说明
本仓库用于存储个人代码项目和工具函数。
## 可用模块
### Fibonacci (斐波那契数列)
`fibonacci.py` - 斐波那契数列迭代实现
**用法:**
```python
from fibonacci import fibonacci
# 计算第 n 个斐波那契数
result = fibonacci(n)
```
**示例:**
```python
>>> from fibonacci import fibonacci
>>> fibonacci(0)
0
>>> fibonacci(1)
1
>>> fibonacci(10)
55
```
**函数说明:**
| 参数 | 类型 | 说明 |
|------|------|------|
| n | int | 要计算的斐波那契数位置(从 0 开始) |
**返回值:** 第 n 个斐波那契数int
**异常:** 当 n 为负数时抛出 `ValueError`
## 运行测试
```bash
python fibonacci.py
```