新增 補充解決方案內,所有專案的註解,並整理 README
@@ -0,0 +1,27 @@
|
||||
```
|
||||
請幫我補上這個解決方案內的所有註解,包括:
|
||||
|
||||
1. **XML 文件註解**:
|
||||
- 類別、介面、列舉的 <summary> 和 <remarks>
|
||||
- 所有方法的 <summary> 和 <remarks>
|
||||
- **所有方法參數的 <param>**
|
||||
- 所有回傳值的 <returns>
|
||||
- 所有屬性的 <summary>
|
||||
|
||||
2. **方法內部註解**:
|
||||
- 說明關鍵操作的用途
|
||||
- 解釋複雜邏輯的原因
|
||||
- 方法的實作與介面的註解相同
|
||||
|
||||
3. **README 文件**:
|
||||
- 每個專案一個 README.md
|
||||
- 包含使用範例
|
||||
- 說明輸入輸出參數
|
||||
- 整理方法的操作流程
|
||||
|
||||
請確保:
|
||||
- **建構子的所有參數都要有 <param> 註解**
|
||||
- 每個方法的每個參數都要有 <param> 註解
|
||||
- 註解要清楚說明參數的用途和預期值
|
||||
- 使用繁體中文撰寫所有註解
|
||||
```
|
||||
Reference in New Issue
Block a user