わさっきhb

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

プログラム説明のために (2)変数・関数・構造体の見方と書き方

「プログラムに出現する,関数名や構造体名について,調査し理解するのにも,少しスキルがいります.
 まず,ライブラリ関数は,http://linuxjm.osdn.jp/で検索して,読んでください.
 表示されるページには,いろいろな情報が書かれています.一つのページで複数の関数を説明していることもあります.『何を行う関数か』『どのような(型および意味の)引数をとるか』『戻り値は何を表すか』に注意して読み取り,答案作成に活用してください.
 Cで書かれたクライアントのソースファイルでは,いくつかの変数の型が『struct addrinfo』またはそのポインタとなっています.この構造体のメンバは,上記サイトのgetaddrinfoのページに載っていますので,目を通しましょう.」


「変数名・関数名の書き方に,配慮をお願いしたいと思います.
 というのも,文章でいきなり『hostname』と書くと,意味が読み取りにくいことがありるのです.ちなみにhostnameというコマンド名もあります.
 そこで,文章で最初にその変数名を挙げるときには『変数hostname』と表記するよう,心がけてください.推敲時に見直すといいでしょう.2番目以降は,『hostname』だけでも通じますが,『変数hostname』のほうが読みやすければ,そのようにしましょう.
 関数名に関しては『strchr関数』でも『関数strchr』でもかまいません.ただしmainに限り,『main関数』と書きます.
 また,ライブラリ関数は,システムコールとライブラリルーチンに分けられますが,今回の答案作成に当たっては区別することなく,『~関数』または『関数~』と表記してください.」