コードコメントにタイトルを書きますか?[閉まっている]
閉じた。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善したいですか?この投稿を編集して事実と引用で答えられるように質問を更新してください。 5年前に閉鎖されました。 私が書いたいくつかの古いコード(大学の1年目)を参照していたときに、コードのさまざまな部分の前にコメントタイトルを書くことに気づきました。のようなもの(これはモノポリーゲームから): /*Board initialization*/ ...code... /*Player initialization*/ ...code... /*Game logic starts here*/ /*Displaying current situation*/ ...code... /*Executing move*/ ...code... /*Handle special event*/ ...code... /*Commit changes, switch to next player*/ ...code... これは冗長であり、コードが非常に明確であれば間違いなく不要かもしれませんが、ファイルをスキャンしてみると、実際のコードをほとんど見ていなくても、何が起こっているのかを知っているように強く感じました。特定の状況でこれが適切であると私は間違いなく見ることができるので、これをしますか?それは良い考えだと思いますか?それとも多すぎますか?