c-sharp
C#開発におけるBlazor、Unityゲーム開発、および.NETバックエンドのベストプラクティスをまとめたガイドラインです。フロントエンドからゲーム開発、サーバーサイドまで幅広いC#の用途に対応した指針を提供します。
description の原文を見る
Guidelines for C# development including Blazor, Unity game development, and .NET backend best practices
SKILL.md 本文
C# 開発ガイドライン
.NET、Blazor、Unity、および最新の C# 言語機能に関する深い知識を持つ C# 開発のエキスパートです。
コードスタイルと構造
- 簡潔で慣用的な C# コードを書き、正確な例を示す
- .NET および C# の規約とベストプラクティスに従う
- 必要に応じてオブジェクト指向プログラミングと関数型プログラミングパターンを使用する
- コレクション操作には LINQ とラムダ式を優先する
- わかりやすい変数名とメソッド名を使用する (例:
IsUserLoggedIn、GetUserById) - .NET の規約に従ってファイルを構造化する (Controllers、Models、Services など)
命名規則
- クラス名、メソッド名、public プロパティには PascalCase を使用する
- ローカル変数と private フィールドには camelCase を使用する
- 定数には SCREAMING_SNAKE_CASE を使用する
- インターフェースの前に "I" を付ける (例:
IUserService) - private フィールドの前にアンダースコアを付ける (例:
_userRepository)
C# 言語機能
C# 10+ 機能
- ファイルスコープの名前空間を使用してコードを簡潔にする
- 共通の名前空間に global usings を使用する
- 不変データ型には records を活用する
- 型チェックとデコンストラクションにはパターンマッチングを使用する
- null 参照型を適切なアノテーションとともに使用する
モダン構文
- 単純なメソッドとプロパティには式本体メンバーを使用する
- ターゲット型指定の new 式 (
new()) を使用する - 簡潔な条件ロジックには switch 式を使用する
- 文字列連結ではなく文字列補間を使用する
エラーハンドリング
- 予期された例外には try-catch ブロックを使用する
- ドメイン固有のエラー用にカスタム例外クラスを作成する
- パラメータ検証には
ArgumentNullException.ThrowIfNull()を使用する - 必要に応じて操作結果の Result パターンを実装する
- コンテキスト情報と共に例外をログに記録する
API デザイン
- Web API には RESTful 規約に従う
- レイヤー間のデータ転送には DTO を使用する
- 適切な HTTP ステータスコードを実装する
- 横断的関心事には action フィルターを使用する
- API は適切にバージョン管理する
パフォーマンス
- I/O バウンド操作には
async/awaitを使用する - 必要に応じてキャッシュを実装する
- ループ内の文字列連結には
StringBuilderを使用する - ジェネリクスで boxing/unboxing を回避する
- 高パフォーマンスシナリオでは
Span<T>とMemory<T>を使用する
依存性注入
- 依存性には constructor injection を使用する
- サービスを適切なライフタイム (Scoped、Transient、Singleton) で登録する
- サービス抽象化にはインターフェースを使用する
Program.csまたはStartup.csで DI を構成する
テスト
- xUnit または NUnit を使用してユニットテストを記述する
- Moq または NSubstitute を使用してモックを作成する
- Arrange-Act-Assert パターンに従う
- ビジネスロジックの高いテストカバレッジを目指す
- FluentAssertions を使用して読みやすいアサーションを行う
セキュリティ
- すべてのユーザー入力を検証する
- SQL インジェクションを防ぐためにパラメータ化クエリまたは Entity Framework を使用する
- 適切な認証と認可を実装する
- シークレットを設定に保存する (User Secrets、Azure Key Vault)
- すべての通信に HTTPS を使用する
Blazor 固有のガイドライン
- コンポーネントベースのアーキテクチャを使用する
- 適切な状態管理を実装する
- 共有状態には cascading parameters を使用する
@keyと virtualization で レンダリングを最適化する- コンポーネントのライフサイクルイベントを適切に処理する
Unity 固有のガイドライン
- ゲームオブジェクトの動作には MonoBehaviour を使用する
- データコンテナには ScriptableObjects を実装する
- モジュール化には Component パターンに従う
- 時間ベースの操作には coroutines を使用する
- 頻繁にインスタンス化されるオブジェクトにはオブジェクトプーリングを実装する
ライセンス: Apache-2.0(寛容ライセンスのため全文を引用しています) · 原本リポジトリ
詳細情報
- 作者
- mindrally
- リポジトリ
- mindrally/skills
- ライセンス
- Apache-2.0
- 最終更新
- 不明
Source: https://github.com/mindrally/skills / ライセンス: Apache-2.0
関連スキル
doubt-driven-development
重要な判断はすべて、本番環境への展開前に新しい視点から対抗的レビューを実施します。速度より正確性が重要な場合、不慣れなコードを扱う場合、本番環境・セキュリティに関わるロジック・取り消し不可の操作など影響度が高い場合、または後でバグを修正するよりも今検証する方が効率的な場合に活用してください。
apprun-skills
TypeScriptを使用したAppRunアプリケーションのMVU設計に関する総合的なガイダンスが得られます。コンポーネントパターン、イベントハンドリング、状態管理(非同期ジェネレータを含む)、パラメータと保護機能を備えたルーティング・ナビゲーション、vistestを使用したテストに対応しています。AppRunコンポーネントの設計・レビュー、ルートの配線、状態フローの管理、AppRunテストの作成時に活用してください。
desloppify
コードベースのヘルスチェックと技術負債の追跡ツールです。コード品質、技術負債、デッドコード、大規模ファイル、ゴッドクラス、重複関数、コードスメル、命名規則の問題、インポートサイクル、結合度の問題についてユーザーが質問した場合に使用してください。また、ヘルススコアの確認、次の改善項目の提案、クリーンアップ計画の作成をリクエストされた際にも対応します。29言語に対応しています。
debugging-and-error-recovery
テストが失敗したり、ビルドが壊れたり、動作が期待と異なったり、予期しないエラーが発生したりした場合に、体系的な根本原因デバッグをガイドします。推測ではなく、根本原因を見つけて修正するための体系的なアプローチが必要な場合に使用してください。
test-driven-development
テスト駆動開発により実装を進めます。ロジックの実装、バグの修正、動作の変更など、あらゆる場面で活用できます。コードが正常に動作することを証明する必要がある場合、バグ報告を受けた場合、既存機能を修正する予定がある場合に使用してください。
incremental-implementation
変更を段階的に実施します。複数のファイルに影響する機能や変更を実装する場合に使用してください。大量のコードを一度に書こうとしている場合や、タスクが一度では完結できないほど大きい場合に活用します。