一つのアプリケーション内で、
キャメルケース(fooBar)
パスカルケース(FooBar)
スネークケース(foo_bar)
と、命名法が混在しているのが気になるんだけど
クラス名やメソッド名、変数名のことね
データベースのカラム名もだね
命名法を含めたコーディングスタイルは、メンバー同士の論争になりやすいから、巻き込まれないようにね
開発チームのルールを決めて、自動チェックするか
自動チェックしないなら、命名法の混在を許容して、気にしないほうがいいわ
混在していても、いろいろな名前の付けかたがあるのね、とわかっておもしろいけどね
つまり、
(1)フレームワークのルールにしたがう。
(2)上の範囲内で、開発チームのルールを決めて、コーディングルールチェッカーを設定する。
GithubActionでコーディングルールチェッカーを走らせる
(3)上の範囲内で、外部ライブラリや外部サービスを使うとき、そのサンプルソースにしたがう。
(4)上の範囲内で、残りは開発者の自由。
パスカルケースとスネークケースをハイブリッドしたパターンもあります(FooBar_Baz)
PHP4のころのパッケージ集 PEARで使われていました。
今でもクラスエイリアスで使われています。
'FooBar\Baz\Exception' => 'FooBar_Baz_Exception',
Code language: plaintext (plaintext)
じゃあさ、気になった箇所をリファクタしてリネームしてもいいのかな
private変数、privateメソッド、ローカル変数はご自由にどうぞ
クラス名は?
クラス名の変更は、セマンティックバージョニングでいうところの破壊的変更ね、後方互換性がないアップデートね
リリース前ならリネームしてもいいよね
もちろん
他人が作ったクラスのリネームは?
どこで使っているか自信がないなら、リネーム前のクラス、リネーム後のクラス、2つ用意したほうがいいわね。
リネーム前のクラスには「何年何月に廃止予定」とコメントしておいてね。
データベースのテーブル名やカラム名は?
ウルトラ級の破壊的変更ね。気にしない人もいるけど、私は怖くてやりたくないわ
私なら、コード内かWikiにコメントを残すだけにしておくわね
SQLのカラムコメントもそのままでいいと思うぐらいよ