SDLライブラリ レンダラーに渡すという処理のコードにコメント書く際バックバッファ－に書き込むというコメントの書き方は間違えているのか？

Question

断片的なコードですが必要なのでこの量のコードです。///コメントの関数ですがmRenderer変数を使って描画のために変数を渡していますがこれは
ダブルバッファリングで行っているのででフロントバッファとバックバッファーを使ってフロントバッファが表示されている画面で次のフレームでバックバッファをフロントバッファに流してまたバックバッファを作って流してという処理だと思われるのですが。この行にはどんなコメントを書くのが正解？なのでしょうか？　ただ描画するとかでもいいともいますが。

void Game::GenerateOutput()//レンダリング画面を生成
{
    SDL_SetRenderDrawColor(mRenderer,0,0,255,255);
    SDL_RenderClear(mRenderer);

    


    SDL_RenderPresent(mRenderer);//////レンダリング
}

Answer 1

何が「正解」なのかというのは，あなたがそこにコメントを書く 意図/理由 によるでしょう．
その 意図/理由 に対して十分な記述をしておけばよいのではないでしょうか．

そのコメントは一体何のために書くのですか？
誰に向けたものですか？（他者がそのコードを読む可能性があるのか，自分しか見ないものなのか）

仮に，自分しか見ないコードだとして，自身が

ただ描画するとかでもいい

と思っていて，且つ，そこにそのコメントを書くことに意味があるのであれば，それでいいのでは？

---

「SDL_RenderPresentって何？　何のためのもの？」ということをコメントとして残しておく必要があるような場面においては，
SDL_RenderPresentの行だけにコメントを書くのでは不十分に思います．
なので，例えば以下のように，前段の記述との関連性がわかるように書くとかすればどうだろうか，と思います．

//(1)レンダリング
SDL_SetRenderDrawColor(mRenderer,0,0,255,255);
SDL_RenderClear(mRenderer);
...

//(2)レンダリング結果を表示に反映する
SDL_RenderPresent(mRenderer);

より詳細に何かを書く必要を感じるのであれば，こんな感じでしょうか．
（※SDL自体の話はあまりよく知らないので，下記のコメントの内容は正しくないかもです．）

//(1)レンダリング
//まず，mRendererが内部で持っているバックバッファ?に描画する
SDL_SetRenderDrawColor(mRenderer,0,0,255,255);
SDL_RenderClear(mRenderer);
...

//(2)レンダリング結果を表示に反映する
//バッファをswapする（バックバッファに描画した内容が表示される）
SDL_RenderPresent(mRenderer);

Comments

[fana]

１人で趣味でプログラムを書いているような場合においては，コメントは全て"対自分用"です．
”未来の自分に向けて"書き残しているわけです．
であれば，未来の自分が読んで わかる/ためになる ものを書く．

「熟練者なら一単語でわかるような話でも，私には数行の文章による丁寧な説明がないとわからない」ような場合には，
気取って一単語をコメントに書いていても意味が無いので，必要な情報は必要なだけ自分が読める形で書く．
どのくらい書いておけばよいのか？は自身の能力（記憶力，読解力，etc）と相談して決める．