コメントコーディングで実装内容を明確化しよう

前置き

私は実装が苦手なので、日頃から頭で考えるより紙に書いたり、PCのメモに書いたりして頭の中を整理をするようにしています。
その一環で、時間があるときは実装時にコメントコーディングしてみるということをしています。
実装苦手な人やプログラミング初心者向けの紹介になります。

コメントコーディングの方法

”自分が日頃使っている言語でコーディングしてみる”これが大きな特徴だと思います。
私は日頃から日本語を使っているので日本語で書いてるのですが、注意したいのは「箇条書きをする」というところです。

    public function 東京駅から福岡空港まで行く値段を計算する() 
    {
      //自宅から東京駅まで行く値段を計算
      //東京駅から羽田空港まで行く値段を計算
      //羽田空港から福岡空港まで行く値段を計算
      //福岡空港から博多まで行く値段を計算
    }

これほど大雑把でもこのコメント4行をメソッドにしてみようかと考えることができます。
また上記は駅や空港を限定していますが、場所を限定しないで他パターンを考えると細かくなります。
すこし大雑把なのでこのコメント4行を少々細かくしてみよう

    public function 東京駅から福岡空港まで行く値段を計算する() 
    {
      //自宅から東京駅まで行く値段を計算
      //東京駅から羽田空港まで行く値段を計算
      //羽田空港から福岡空港まで行く値段を計算
      //福岡空港から博多まで行く値段を計算
    }

    public function 自宅から東京駅まで行く値段を計算() 
    {
      //車で行く
      //タクシーで行く
      //地下鉄で行く
      //JRで行く
      //バスで行く
      //歩きで行く

      //値段を返す
    }
    .
    .
    .
}

「自宅から東京駅まで行く値段を計算」をメソッド化してみました。
東京駅まで行くには様々な手段があるためこのように書いています。
また上記の内容に、使う金額が変動する、行く人の人数が変動する、電車の中でご飯を食べる、などを考慮するとさらにコメントの行数が増えます。この辺の考慮は設計書や要件定義をみて判断するといいと思います。

まとめ

コメントで箇条書きをするだけでも、どのようなメソッドを作っていったら良いかをあらかじめ把握することができます。
また、設計書や要件定義に記載されていない場合は設計者に考慮が必要か質問をすることができます。
考慮漏れなども発見できる為、とても実装しやすくなります。
参考になれば幸いです。

参考文献

コーディングの手助けとなる "コメントコーディング" を紹介
https://qiita.com/tatsuo-iriyama/items/7a00c3191cde70c918c3