[章番号]: [クラス名/モジュール名] API仕様書
このテンプレートの使い方
このファイルは、ライブラリとして提供される公開クラスやメソッドの仕様を定義するためのテンプレートです。 詳しい使い方は「設計仕様の書き方ガイド」を参照してください。
1. 概要
2. クラス/インターフェース詳細
2.1. [クラス名]
概要:
プロパティ
| 名前 | 型 | get/set | 説明 |
|---|---|---|---|
[プロパティ名] |
[型] |
get, set |
[プロパティの簡単な説明] |
メソッド
[メソッド名1]([引数])- [メソッドの簡単な説明]
[メソッド名2]([引数])- [メソッドの簡単な説明]
コード例
// このクラスのインスタンス化と主要なメソッド呼び出しの例
var manager = new BufferManager();
var buffer = manager.Rent<byte>(1024);
3. メソッド詳細
3.1. [メソッド名]
public Task<User> GetUserAsync(string userId)
- 概要:
指定されたIDのユーザー情報を非同期に取得します。
- 引数:
| パラメータ名 | 型 | 説明 |
| :----------- | :------- | :------------------------------------------------------------- |
| `userId` | `string` | 取得するユーザーの一意なID。nullまたは空であってはなりません。 |
- 戻り値:
- `Task<User>`: ユーザーが見つかった場合、そのユーザー情報（`User`オブジェクト）を結果として含むTask。
- ユーザーが見つからない場合は、結果が `null` のTaskを返します。
- スローする例外:
- `ArgumentNullException`: `userId`が`null`の場合にスローされます。
- `DatabaseConnectionException`: データベースへの接続に失敗した場合にスローされます。