より良いコメントを書く旅

TL実際のコードを書く前に書きます
あなたは、あなたがより多くの、より良いコメントを書く方法を聞きます.しかし、これは我々はおそらくすべての闘争と習慣です
数日前、私はそれが何をすべきかわかっていました.そして、それは指定された経路でイメージをとって、異なる幅でそのイメージのコピーを元のイメージのサブフォルダに作成することです、サブフォルダの名前は新しい幅です.
以下にこの関数の基本構造を示します(はい、PHPを書きます.

    public function compressImage(string $imagePath, int $size)
    {

    }

私はどのような機能を行う必要があります知っていたが、それは私が望んだことを行う方法を知っていなかったので、私はコメントの形で私のアイデアを書き留めた.

    public function compressImage(string $imagePath, int $size)
    {
        // Find out path of original image
        // Scale down image
        // Create new path if it does not exist yet
        // Save scaled down version in new path
        // Return relative path to compressed Image
    }

これで私はどうにか心を整理した.次に、実際にコードを書いている部分が来ました.コメントは、私が何をすべきかということを私に伝えたので、今はとても簡単でした.これが最後の機能です.

    public function compressImage(string $imagePath, int $size)
    {
        // Find out path of original image
        $originalImgPath = '';
        $splImgPath = explode('/', $imagePath);
        $fileName = array_pop($splImgPath);
        $originalImgPath = implode('/', $splImgPath);

        // Scale down image
        $imgObject = imagecreatefromstring(file_get_contents($imagePath));
        $scaled = imagescale($imgObject, $size);

        // Create new path if it does not exist yet
        if (!is_dir("${originalImgPath}/${size}")) {
            mkdir("${originalImgPath}/${size}", 0777, true);
        }

        // Save scaled down version in new path
        imagejpeg($scaled, "${originalImgPath}/${size}/${fileName}");

        return "${originalImgPath}/${size}/${fileName}";
    }

(私は基本的に実際のスケーリングの一部をコピーすることができたので、幸運でした(私が数カ月前に書いた関数からimagejpeg($scaled, "${originalImgPath}/${size}/${fileName}");のように、それは非常にまっすぐ前方でした).
私は、あなたがこのアプローチが面白かったことを見つけて、少なくともそれをあなた自身のプロジェクトの1つで試してみることができることを望みます.私はまた、良いコメントを書く方法についてのあなたのアイデアを聞いて喜んでいる.
最後に、素敵な一日をお過ごしください