ホーム

スタッフブログ

2023年11月10日

コードレビューでよくある指摘(1)

こんにちは

システムチーム プログラマー / マネージャーのAです。

 

プログラムの話ですが

CSSコーディングにもつながる話です。

みんなのコードレビューへの抵抗を減らしたく、色々書きます。

 

初回は取っつきやすく

よくある例を、2つだけ紹介します。

まずはこの2つを大事にしてください。

 

 

インデントを揃える(頻出度★★★)

意外に、よく指摘します。

インデント ≒「行の初めの位置」のことです。

 

ぶっちゃけ崩れていても動くんですが、

インデントを揃えられない精神状態で

開発していること自体、危ないなーと思っています。

 

この指摘を受けた場合、

一旦立ち止まって、落ち着きましょう。

大丈夫なので、一旦全部見直して、綺麗にしてください。

 

 

変数・クラス名のパターンを揃える(頻出度★★★)

初心者卒業くらいのタイミングで、やりがちです。

 

名前のパターンには

スネーク、キャメル、コンスタント…

など、色々あるんですが

 

たまに

ケバブアッパースネークケース…?

みたいなのに遭遇して、差し戻します。

 

開発者の心境には共感します。

「命名を際立たせて、”例外感” を演出したい」

という所だと思います。理解できます。

 

ただ

変数名を憶えづらくなるので、

基本的には一本に絞るべきです。

例外感の演出には、他のやり方で。

 

自分は基本、キャメルケース一本でやってます。

例外としては、定数 と BEM記法 です。

 

 

ちゃんと動く機能のコードは、美しい。

見た瞬間「あ、これは大丈夫だろうな」と思う時があります。

安定して正しく動く処理 のコードは「美しい」です。

 

細かい話は色々ありますが

美しさを出すには、「手を抜かない」ことだと思います。

「一旦、このクラス名で~」みたいなことをしない。

 

手を抜かない積み重ねがコードを美しくするし、

美しいコードが、ちゃんと動く処理を産みます。

 

1個1個手を抜かず、丁寧に書く。

 

それが優秀なPGの特徴のうちの1つかな、と思いますので、

まずは目の前のコードを、少し見直してみてください。

求人バナー

このページの上部へ戻る