質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

90.00%

ソースコードの保守性を保つために心がけていることはなんでしょう?

受付中

回答 4

投稿

  • 評価
  • クリップ 0
  • VIEW 1,374
退会済みユーザー

退会済みユーザー

ソースコードを書いていて、フレームワークを使用しているのである程度保守性は担保されていると思いますが、どう考えてスパゲッティーコードになっているという実感があります。記述していくたびに、それが増大していき、後々見た時、どういう処理を行っているのか理解に苦しむ場面が多々有ります。

例えばビジネスロジックを記述する部分などの分離がきちんと統一できていないところや、条件分岐や繰り返し分のネストの深さ。クラスメソッドやインスタンスメソッドを多用し、またそれらが、他のクラスメソッドやインスタンスメソッドを利用しているなど。
ソースコードから、どういう処理を行っているのか読み取るのは至難の技です。

そこで皆さんに、日頃、新しいシステムのコーディングを一からスタートするにあたって、心がけている点や、スパゲッティーコードにならないための手法などあれば教えていただきたいです。

自分は変数や関数の命名には気をつけておりますが、どうしても命名が長くなってしまうことなどあります。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 4

0

正直、新規で書く場合は、保守性はあまり考えません。

理由は2つあります。

一つは、私の場合は多くバグを作るので修正するときにバグの原因を考えると、コーディングに問題がありかなり修正を加えます。また、ユーザーに確認を取ると必ず追加の要件(要件漏れ)があるので、それを追加すると自然とリファクタリングが進みます。強いて言えば、つねにリファクタリングすることでしょうか。

もう一つは、今後の保守のことは基本的にわからないということです。保守で困ったらそのときに、修正するというくらいのつもりでいます。経験的にできるだけシンプルにしたほうが結果的にわかりやすいことが多いです。

命名に関しては、ドメインを意識すれば、ある程度は短くなります。私の場合はパッケージやクラスを考えると冗長な名前になっているか、バッケージやクラスを分割すべき場合に長い名前になっていることが多いです。

メソッドがメソッドを呼び出している点は問題ないと思います。適切に役割を分割すると、短いメソッドを大量に作るのは当然のことです。もしそれで、読みづらいと感じているのなら、保守のときに関係のない処理まで読もうとしているか、中を確認しなくては行けないほど命名がまずいかです。(処理が適切に分割されていない場合もあるかもしれません・・・)

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2016/11/20 00:55

    > 保守のときに関係のない処理まで読もうとしているか、中を確認しなくては行けないほど命名がまずいかです
    とても参考になりました。回答ありがとうございます!

    キャンセル

0

コードが汚いことがわかるなら下の2つを繰り返し行うといいですよ。

実装フェーズ-作りたい機能を実装する、この時はスパゲティコードになっても構わないので、時間をかけずに実装を進める。

リファクタリングフェーズ-機能ができて動くようになったら、IDEのリファクタリング機能を多用してスパゲティをほぐす。実装フェーズからなるべく時間をあけずに行うことが重要。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

0

極力テストコードを書くようにする。
テストコードの有無でリファクタリングの回転スピードが格段に違います。
テストコードを書くのは面倒という声をきいたりもしますが、1回テストコードを書いた開発に触れると、逆にテストコード無しで開発するのはキツいです。。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

0

シンプルに実装すること
できる限りだれが見てもわかる実装に努める

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 90.00%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる