わさっきhb

大学(教育研究)とか ,親馬鹿とか,和歌山とか,とか,とか.

プログラム説明のために (1)読んで理解し,きちんと説明しよう

「この課題で,学んでほしいことは,2つあります.
 一つは,『C言語でのソケットプログラミングの理解』です.
 前回の授業でコンパイルして実行させた,Cで書かれたクライアントのソースファイルを,よく読んで,理解に努めてください.
 理解をするには,Cプログラミングの知識と,インターネット通信の知識の両方が必要です.
 Cプログラミングの知識としては,『*』『&』『->』などの演算子の使われ方,いくつかのライブラリ関数,関数呼び出しにおける参照渡し,そして連結リスト(これはリンクリストまたは線形リストとも呼ばれます)のアクセス方法などを,挙げることができます.
 インターネット通信の知識というのは,例えばTCP,コネクション型,ホスト名・ポート番号などです.
 『忘れた』『前期に受講していない』という人は,検索して得た情報を,活用してください.
 学んでほしいことのもう一つは,『プログラムコードの説明』です.
 前回の授業のクライアントのCのファイルに書かれた処理内容を,日本語で説明するという課題に,取り組んでもらいます.
 この課題は昨年度までにない新作です.事前にこちらで,答案を作ってみると,推敲は別で1時間を要し,字数は2500字ほどになりました.労力・分量の参考にしてください.
 説明にあたっては,パラグラフライティングを推奨します.空行で区切られた,処理のまとまりごとに,パラグラフとして,構成してください.トピックセンテンスは,パラグラフの最初の文とすることを,心がけましょう.
 ですので,ソースファイルに書かれた内容を,1行1行,日本語で表せばOK,というわけではありません.これに関しては,HOW・WHAT・WHYを意識するといいでしょう.
 HOWは,『それぞれの処理をどのように実行していくか』です.次にWHATは,『一連の処理で何を行うか』です.それからWHYというのは,『なぜそこにそのコードが書かれているか』です.とはいえ,WHYは,すべての段落に書く必要はなく,ここぞというところで,効果的に記述しましょう.
 プログラムコードを自然言語で説明するというスキルは,コードにコメントを書いたり,gitをはじめとするバージョン管理システムで,コミットメッセージを作ったりする際に,活用してください.」