04.コーディング規定

このセクションでは、ソースコードや設定ファイルなど、プロジェクトで作成されるあらゆるテキストファイルの品質と一貫性を保つための規約を定めます。

一貫したコーディングスタイルは、可読性を高め、バグを減らし、チーム開発を円滑にします。

---

基本的な考え方

全ての言語やファイル形式に共通するコーディングの「思想」や「原則」を、まず最初に01.共通コーディング原則で定義しています。

各言語の具体的な規約を参照する前に、まずはこちらに目を通し、プロジェクト全体のコーディングに対する価値観を共有してください。

---

サブカテゴリ一覧

この規定は、以下の技術スタックごとに分類されています。

• 01.共通コーディング原則:

  • 全てのプログラミングに共通する、言語非依存の原則。

• 02.開発言語:

  • C#, Python, C/C++など、アプリケーションの主要ロジックを記述するための言語規約。

• 03.Web開発:

  • TypeScript, HTML, CSSなど、Webフロントエンド開発に特化した規約。

• 04.スクリプト・データ定義:

  • ShellScriptやSQLなど、開発補助やデータ操作に用いる言語の規約。

• 05.設定ファイル:

  • JSON, YAML, Markdownなど、設定やドキュメントで用いるデータ形式の規約。

---

ツールの活用

DevBlueprintでは、規約を手作業で遵守するのではなく、Prettier (フォーマッター) や ESLint, Ruff (リンター) といったツールを導入し、スタイルを自動で強制することを強く推奨します。