エンジニアのひよこ_level10

毎日更新してた人。たまに記事書きます。

【プログラミング】コメントで設計してからコーディングする【396日目】

プログラムを書く前に流れをメモ

プログラミングをするとき、どんなふうにコーディングしますか?

とりあえず思いつくコードを書きますか?

コードの流れをメモして、そして流れができたら実際に実装しますか?

私は大まなか流れを書いてからコードを書きます。

こんな感じに書いてるよってのをここで。

コメントで流れを書く

// ユーザーを登録する

// メールを送る

関数名を書く

// ユーザーを登録する
$user = $this->createUser($user_data);

// メールを送る
$this->sendMail($user);

空の関数を書く

// ユーザーを登録する
$user = $this->createUser($user_data);

// メールを送る
$this->sendMail($user);


// 中身はなく、型をあわせるか、0等適当な値を返す
function createUser($user_data)
{
    // ユーザーを作成する

    // 作成したユーザーを返す
    return new User();
}

function sendMail($user)
{
    //メールを送る
}

何が嬉しいの?

これ、このままでも動きます。

常に動作確認が出来る状態です。

まず、土台を作る、そしてそれを少しずつ組み立てていく感じ。

しかも、コメントで内容書いているので、何作るかも迷わない。
出来上がったコードにはコメントがすでにあり、しかも流れがぐっちゃぐちゃになりにくい。

プログラミング慣れてきたら、こんなふうに書くのはわりとおすすめ。