github-actions[bot]
e0d4492013
Created by Github action Co-authored-by: github-actions <github-actions@twenty.com>
23 lines
2.2 KiB
Plaintext
23 lines
2.2 KiB
Plaintext
---
|
|
title: ベストプラクティス',
|
|
---
|
|
|
|
この文書は、バックエンドで作業する際に従うべきベストプラクティスを概説しています。
|
|
|
|
## モジュール化アプローチを採用する
|
|
|
|
バックエンドは、NestJSを使用する際の基本原則であるモジュラーアプローチを採用しています。 コードを再利用可能なモジュールに分割し、クリーンで整理されたコードベースを維持してください。
|
|
各モジュールは特定の機能や機能性をカプセル化し、明確なスコープを持つべきです。 このモジュラーアプローチにより、関心事を明確に分離し、不要な複雑さを排除します。
|
|
|
|
## モジュールで使用するサービスを公開する
|
|
|
|
常に、明確で単一の責務を持つサービスを作成してください。これにより、コードの可読性と保守性が向上します。 サービスには意味のある一貫した名前を付けてください。
|
|
|
|
他のモジュールで使用したいサービスを公開する必要があります。 サービスを他のモジュールへ公開することは、NestJS の強力な依存性注入システムによって可能であり、コンポーネント間の疎結合を促進します。
|
|
|
|
## `any` 型の使用を避ける
|
|
|
|
変数を `any` として宣言すると、TypeScript の型チェッカーは型チェックを行わなくなり、その変数にはあらゆる型の値を割り当てられるようになります。 TypeScript は、値に基づいて変数の型を決定するために型推論を使用します。 `any` として宣言すると、TypeScript は型を推論できなくなります。 これにより、開発中に型に関連したエラーを捕捉しにくくなり、実行時エラーを引き起こし、コードのメンテナンス性、信頼性が低下し、他の人が理解しづらくなります。
|
|
|
|
これがすべてに型を持たせるべき理由です。 したがって、名と姓を持つ新しいオブジェクトを作成する場合は、操作しているオブジェクトの構造を定義する、名と姓を含むインターフェースまたは型を作成する必要があります。
|