リファクタリング

コードのリファクタリングには二種類あるという説。

保守性をあげるためのリファクタリング

本やネット上で言われているリファクタリングは、主にこちらのような気がします。

各関数は再利用性をあげるために汎用化し、重複コ ...

今日コードレビューをつけてコメントをもらったのですが、関数名や変数名にはできるだけ略語を使わない方がいいと感じました。

そのシステムで共通の認識となっている略語なら良いと思いますが、即席でつけた略語は他の人が見た時に理解を ...

コードは人が読むためのものです。

そのため、人にとって分かりやすいものである必要があります。

分かりやすいためには以下の二つを両立する必要があります。

シンプル
十分な情報が含まれている

Array.map を使ったりすると以下のような少しわかりづらいコードを書くことがあります。

const myFunc = (arr) => { return arr.map(value => { return { ...

一つのファイルが大きくならないようにすることは可読性の向上に貢献しますが、逆にファイルを分けすぎると良くない場合があります。

これまでに、システムがどのように動くのかを知りたい時に、関数から関数の呼び出しごとに新しいファイ ...

コードは上から下へと読みますが、その時に処理のまとまりが直感的にわかると良いです。

例えば一つの関数の中でも、処理段階によっていくつかに分かれると思います。

そのようなまとまりを表現する際には、空行を挟むと良い ...

新聞のようにコードを書くことで秩序のある書式を保つことができるという論があります。

以下がポイントです。

クラス名や関数名をみればそのファイルが何をするコードが書かれているかがわかる(見出し)
ファイルの上部に ...

例えば以下のようなコメントがあったとします。

//ここでのurlは、テスト環境では 本番環境では です。

補足のため非常に親切なように見えますが、このような情報をコードに埋め込んでしまうと、いざurlが変わったときにコメン ...

引数の数は少ないに越したことはないですが、以下は個人的な基準です。

引数なしが理想

引数がないのが一番シンプルです。

しかし、動的に結果が変わるのがプログラムなので、このケースはあまりない気がします。

関数の引数がフラグ(boolean)だった場合は、その関数をリファクタリングするチャンスかもしれません。

というのも、フラグを引数にとっているケースでは、そのフラグによって処理を分岐している可能性があるからです。