全員共通のコードフォーマットの設定を追加したい

Elise3993 commented 3 months ago

コード規約や綺麗さを、人の手によって守ろうとすると色々不都合が起きる
- コーディング規約を全員で決めてもヒューマンエラーが起き得る
- コーディング規約を厳密に考えながらコーディングするのは時間がかかる
- 規約で厳密に決めないようなルール、例えば行末の改行やスペースの数、インデントがタブorスペースとかが、人によって変わるとコミットでのDiffがちょっと見づらくなる

ざっと調べた限りでは2つほど出てきた。手間が少なそうなので、EditorConfigの方を採用したいと思ってます

Artistic Style
- 手順
- Astyleをサイトからダウンロードする
- フォーマットの設定を記述するオプションファイルを作成
- コマンドを叩いてフォーマットを行う
- Gitのpre-commitという機能の設定を各自指定することで、commit前にフォーマット漏れを防げる
- 参考記事 : チーム内で Unity C# のフォーマットを揃える
- 参考記事 : プロジェクト単位でのソースコードの整備効率化(Windows初級編)
EditorConfig
- 手順
- プロジェクトの最上階に.editconfig というファイルを設置
- 参考記事 : EditorConfigを使って、どんなエディタでも一貫したコードフォーマット

Elise3993 commented 3 months ago

どうも無さそうではあったのですが、「不要な改行を詰める」みたいな設定オプションが設定できると大変うれしいので、見つけた人は教えてもらえると嬉しいです。

AiletS commented 3 months ago

editorconfig.txt テンプレはこれ使ってました

Elise3993 commented 3 months ago

これほとんどそのまま採用しますか...（どこから持ってきた設定何だろう🤔）

一応ある程度オプションの意味軽く調べて、修正・設定適用なりしてPR出そうと思います。PRのときに大事なオプションについては伝えます

Elise3993 commented 3 months ago

editorconfig.txt テンプレはこれ使ってました

dugite-git commented 3 months ago

これappディレクトリ直下に置く感じですかね

Elise3993 commented 3 months ago

外部パッケージが入らない場所の最上階に置きたいからAssets直下になるのかな？

dugite-git commented 3 months ago

あーたしかに

Elise3993 commented 3 months ago

詳細調べたら割と理解に時間かかりそうなので少々お待ちください

CASru-GAME / TeamGameDevBootcamp