コメントの大切さ

コメントとは

コメントの例

ソースは本当の仕様書

関数の引数と出力

/*
=============================================================================

        引数で指定された文字列を格納するだけのメモリを動的に確保した後、
        中身を転送して、ポインターを返す。

        引数 char *a_moto 移したい文字列
        返値 NULL以外：確保した場所のポインター
             NULL    ：失敗

=============================================================================
*/
char * char_malloc(char *a_moto) {
     int nagasa;
     char *mojip;
     char *a_saki;

    /*元の長さを測って、NULLコードが入る分上乗せする*/
    nagasa=strlen(a_moto);
    nagasa++;

    /*メモリ確保*/
    if (NULL == ( a_saki=malloc(nagasa))) {
          fprintf(stderr,"RTemu:out of memory\n");
          return NULL;
    }
    
    bzero(a_saki,nagasa);

    /*  コピー */
    mojip=strcpy(a_saki, a_moto);
    return a_saki;
}

ソースの読みやすさはすべてに優先する

/*CRコード*/
if (moji1==0x0d) {
        *(kekka2+cnt2)=0x5c;
        *(kekka2+cnt2+1)=0x72;
        cnt2+=2;
        seigyoflg=1;
}

/*LFコード*/
if (moji1==0x0a) {
        *(kekka2+cnt2)=0x5c;
        *(kekka2+cnt2+1)=0x6e;
        cnt2+=2;
        seigyoflg=1;
}

/*タブコード*/
if (moji1==0x09) {
        *(kekka2+cnt2)=0x5c;
        *(kekka2+cnt2+1)=0x6e;
        cnt2+=2;
        seigyoflg=1;
}

/*￥マーク*/
if (eucenen==1 || sjisenen==1) {
        if (moji1==0x5c) {
                *(kekka2+cnt2)=0x5c;
                *(kekka2+cnt2+1)=0x5c;
                cnt2+=2;
                seigyoflg=1;
        }
}

/*制御コードじゃない*/
if (seigyoflg==0){
        *(kekka2+cnt2)=moji1;
        cnt2++;
}

言語別コメント文のつけ方

# 背景イメージのある場所を指定
$bgimg = "/home/aufheben/public_html/cgi-bin/images/".$in{"bgimg"};

# カウント数のある場所を指定 (777にしておく）
$hdir  = "/home/aufheben/public_html/cgi-bin/data";

# FLYのある場所を指定
$flyprog = "/usr/local/bin/fly";

#文字イメージのあるディレクトリを指定
$digit_dir = "/home/aufheben/public_html/cgi-bin/images";

#gifappendのある場所を指定
$gifappend = "/usr/local/bin/gifappend";

        //------------------------------------------------
        //      入力が適切かどうかチェック
        //------------------------------------------------
        if ($Submit=="登録" || $Submit=="修正") {

                //文字数制限オーバーか？
                $message_length=strlen($message);
                if ($message_length > $MessageMax) {
                        printf("発言の文字数が多すぎます。<br>\n");
                        printf("ブラウザの【←戻る】で戻ってください<br>\n");
                        printf("</BODY>\n");
                        printf("</HTML>\n");
                        pg_close($handle);
                        exit();
                }

//入力のどこかに誤りがないかチェック
function InputCheck(form) {

        var aibo_no;
        var free_icon;

        if (!InputCheck2(form)) {
                return false;
        }

        aibo_no   = form.aibo_no.options[form.aibo_no.selectedIndex].value;
        free_icon = form.free_icon.value;
        if (aibo_no=="free" && free_icon=="") {
                alert("相棒アイコンのあるURLを指定してにゅ");
                return false;
        }

        if (form.passwd.value=="" && form.message.value!="") {
                alert("修正・削除パスワードをいれてにょ");
                return false;
        }

        return true;
}

//チェックボックスが２箇所以上チェックしてないかチェック
function InputCheck2(form) {
        var check_suu;
        check_suu=eval(0);
		：
		：
	　　（以下略）
		：
		：

コメントアウト

$sql="insert into keijiban (onamae, message, passwd) values "
        ." ('$onamae', '$message', '$passwd');";
if (!pg_exec($handle, $sql)){
        die("insertに失敗しました");
}
//printf("sql=[%s]",$sql);

とりあえず多めに作っておく

仕様が曖昧なために、ある処理が必要かどうかわからない場合がります。例えば、入力処理において文字数チェックを入れるかどうか、また、使うことのできない半角記号の入力チェックとか、コードに数字以外があるとエラーにするかどうか、などです。

こういった場合、納期寸前になって「やっぱり必要だった」とか「○○のチェックがない。大至急修正してください」と言われた場合、納期寸前でパニックになっていたり、徹夜明けだったりして頭が働かず、大半が納期前に完成していたにもかかわらず、結局納期オーバーになってしまうケースがあります。

こういう時は、不要なルーチンでもとりあえず作っておきます。もしそれが不要だった場合、「○○の入力チェックが誤動作する」あるいは「○○のチェックは不要」と納期寸前に言われた場合にも、コメントアウトする事で簡単に対応できます。一般に、不足する箇所を作るより多すぎる箇所をコメントアウトする方がミスも少なく、徹夜明けの頭でも簡単に対応が可能なケースが多いです。

コメント文がわかるエディタを使う

おわりに

このページの先頭へ