ソースコードコメントの書き方

に関する教材を、作ることになりました。

学生さん同士のチーム開発でもレビューやっているチーム少ないよね
↓
コードの説明が得意な人が少ないよね
↓
そういえばソースコードにコメントコメントちゃんと書いている学生さん少ないよね
↓
むしろ殆ど書いてない人も多いよね

という話から始まって、しらべてみたところ

「そもそも授業でソースコードのコメントの書き方扱ってないよね」

というお話になりました。

まあ、わたしも、特別に誰かから習った記憶はないですしｗ授業にないのは仕方なかったと思っています。

で、私が教材を作ることになったのですが

改めて「コメントの書き方」の説明をしようと思うと、案外難しいもんですね。

最終的な目的は「学生さんが、自分で書いたコードを、自分で説明できるようになる」なので
「なぜ、こういうコードを書いたか」をコメントに書いてもらう方針で教材を作ろうと思っています。

それが、「第三者が読んでわかるものになっている」なら、モアベターですね。

とりあえず、「コメントにはWhyを書くんだよ」というあたりから、ぼちぼち教材を書き始めます。週末にｗ