46 lines
718 B
Markdown
46 lines
718 B
Markdown
|
# MyClass
|
||
|
|
|
||
|
|
说明：这是一个示例类的类文档。
|
||
|
|
|
||
|
|
## 属性
|
||
|
|
|
||
|
|
### `attribute1 -> int`
|
||
|
|
|
||
|
|
这是第一个属性的说明。
|
||
|
|
|
||
|
|
### `attribute2 -> int`
|
||
|
|
|
||
|
|
这是第二个属性的说明。
|
||
|
|
|
||
|
|
## 方法
|
||
|
|
|
||
|
|
### `method1(arg1, arg2) -> void`
|
||
|
|
|
||
|
|
这是方法 1 的说明
|
||
|
|
|
||
|
|
- `arg1`: 参数 1 的说明。
|
||
|
|
- `arg2`: 参数 2 的说明。
|
||
|
|
- 返回值：这个方法的返回值说明。
|
||
|
|
|
||
|
|
### `method2(arg1) -> int`
|
||
|
|
|
||
|
|
这是方法 2 的说明
|
||
|
|
|
||
|
|
- `arg1`: 参数 1 的说明。
|
||
|
|
- 返回值：这个方法的返回值说明。
|
||
|
|
|
||
|
|
## 示例用法
|
||
|
|
|
||
|
|
```python
|
||
|
|
# 创建一个对象
|
||
|
|
my_obj = MyClass()
|
||
|
|
|
||
|
|
# 调用方法1
|
||
|
|
result = my_obj.method1(arg1, arg2)
|
||
|
|
print(result)
|
||
|
|
|
||
|
|
# 调用方法2
|
||
|
|
result = my_obj.method2(arg1)
|
||
|
|
print(result)
|
||
|
|
```
|