ラベル プログラミング の投稿を表示しています。 すべての投稿を表示
ラベル プログラミング の投稿を表示しています。 すべての投稿を表示

プログラム言語の糞コメントの原因は初学学習にあります

 良く、プログラミング言語のコメントで意味がないと突っ込まれる物があります。

i=0; //iにゼロを代入する

みたいな物です。はっきり言って役に立たないコメントです。しかし、これってどこかで見たことが無いでしょうか? それは「初学者のテキスト」です。

プログラミング言語自体を説明する書籍には当たり前ですが、その命令自身の意味が説明されています。

悪の原因は初学者の解説にコメントを使うこと

私はコメントが誤って使われる原因は、初学者の説明にコメントが使われることです。プログラミング以外でも人など動物って「最初に見たもの」が刷り込まれます。幼少期の時に見たものがその人の「常識」となるわけです。

それと同じように、初学者のテキストに書かれているコメントを最初に見てしまうからその書き方が常識になってしまうわけです。

  1. #include<stdio.h>
  2. int main(void)
  3. {
  4.     int sum=0; //足し算する変数をリセットする
  5.     
  6.     for(int i=1;i<=10;i++){ //1から10までループする
  7.         sum+=i; //現在のカウンターを足し算する変数に加算する
  8.     }
  9.     
  10.     printf("%d\n",sum); //結果を表示する
  11. ;    
  12.     return 0;
  13. }

これはよくある初学者向けテキストに書かれているコメントです。ただ、これを業務でやられると「ゴミコメント」になります。

初学者の学習ではコメントを封印する

上記コードからコメントを除去します

  1. #include<stdio.h>
  2. int main(void)
  3. {
  4.     int sum=0;
  5.     
  6.     for(int i=1;i<=10;i++){
  7.         sum+=i;
  8.     }
  9.     
  10.     printf("%d\n",sum);
  11. ;    
  12.     return 0;
  13. }

そして、初学者の説明として言葉で説明します。

このコードは1から10までをループさせて、その値をSUMという変数に代入します。

forは(変数の初期化;とどまる条件;ループ一回が終了した時の処理)

+= という演算子は足し込むという意味です。例えばsum+=5 とすると sumの値に5を加えるという意味です。

そして、printfでその結果を出力します。

この様な形でコードを説明します。非常にコメントとしてインラインで書きたくなりますが、初学者への変な刷り込み防止という意味で止めて下さい。

本当のコメント術を教える

そして最後に、本当のコメント術を教えて下さい。

  1. #include<stdio.h>
  2. //1から10までの数を足して表示する。
  3. int main(void)
  4. {
  5.     int sum=0;
  6.     
  7.     for(int i=1;i<=10;i++){
  8.         sum+=i;
  9.     }
  10.     
  11.     printf("%d\n",sum);
  12. ;    
  13.     return 0;
  14. }

業務ならこの程度のコメントで十分です。やっていることは1から10までの数を足して表示する物です。このプログラムを実行すれば1から10の合計が表示されるわけであり、特にプログラミングテクニックとしての特記事項はありません。

初学者の学習テキストとしてのコメントを封印するのは苦しいかもしれませんが、初学者である期間は短いです。その後は業務としてのコメントを求められるので、初学者の間違ったコメントを封印することは非常に重要であると考えます。

Amazonでコーディング術

【C言語】バイナリーデータ作成は明確な意思を持つべき

 普段は高レベルなプログラミングをしている人も、業務によっては低レベルなプログラムをすることもあります。近年ではXMLやJSONなどのテキストベースのデータ交換手法や、データベースエンジンへの書き込みでデータのやり取りをするので、そもそもの概念がない人もいます。


データ交換に明確な意思は必要

はるか昔ですが、C言語で整数型のデータをバイナリーデータとしてディスクに保管するサブシステムを作成しました。

仕様は先輩が作っていたのだが、そのときに整数型の順番は決まっているが、どのようにバイナリー化するかが決まっていませんでした。

ビッグエンディアンか?リトルエンディアンか?

気持ち悪いので先輩に聞き返したら。「それぞれ4バイトなのだから順番に入れれば良い」と言われました。それ以上の事は言いませんでした。当然リトルエンディアンなのかわかりません。

とりあえず、ビッグエンディアンとしてプログラムを作成しましたが、後で驚く発言を聞きました。

整数は上位下位が反転するのが常識です

これが、先輩の指示でした。まあ、ひどすぎです。確かにIntel系CPUだと、int型の整数をそのままメモリーダンプすれば、上位下位は逆転します。確かにそのとおりですが、なってしまうって指示は酷いです。

仕様を作るときは、決して「なってしまう」などという表現はしません。明確に行います。この場合なら

  • 整数は4バイトのリトルエンディアンで出力する
  • 実行される環境は全てWindowsでIntelのCPUである
  • 今回はビッグエンディアンの環境では実行されない
  • 今回はパフォーマンスを優先するため、ソフトウェアでの処理は見送る
  • 今回はSUNなどのビッグエンディアンの環境への移植性は考えない

というくらいの指示が必要です。

C言語での実験

#include<stdio.h>

//int型の動きを知るプログラム
main(){

unsigned char buf[10]; //とりあえず10バイト分のバッファを確保
int *iData; //整数型のポインタを宣言

//10バイト分のバッファを全て255で埋める
for(int i=0;i<10;i++){
buf[i]= 255;
}
//整数型のポインタのアドレスをバッファの先頭に設定する
iData = (int *)buf;
//整数型ポインタのアドレスに1000を代入
*iData = 1000;

//バッファの中身を表示
for(int i=0;i<10;i++){
printf("%d\n",buf[i]);

//本プログラムの狙いとしては、全てのバッファを埋めた後、同じアドレスに整数を代入する。
//バッファーが255で無い場合は、整数型の代入によって影響を受けたということになる。
//観察ポイントとしては、255じゃない部分の数が整数型のバイト数。
//数字が昇順であればintel系CPU,じゃなければ他のCPUということになる
//メモリーマッピングをする場合は、この方法は望ましくない。積極的に仕様を決めるべきである。
}
}

以上のコードを実験のために作りました。整数型の変数をメモリにダンプするとどうなるかの確認です。

仮に10バイトの領域を確保し255のデータで埋めます。次に、整数型のポインタを宣言し、そのアドレスを先程の10バイトの領域の先頭に設定します。

そして、その整数型のアドレスに1000を書き込みます。

これを私の環境 Windows11 で実行すると 先頭が232 次が3,次が0、次も0,そして後は255が続きます。

実行結果、最初の4バイトが整数として使われている

これが意味するところは

整数型を代入すると最初の4バイトに値が書き込まれる。先頭が232,次が3ということは収納はリトルエンディアンであるということです。

C言語でプログラムを組んでいる人は、常にこのような実験コードを動かして、ハードウェアの特性を把握しておくことが必要です。

ソースコード

繰り返しますが、「リトルエンディアンになってしまう」という意識でプログラムは組まないで下さい。「リトルエンディアンにする」、「ビッグエンディアンにする」という明確な意思と、妥協するのであれば考えた上で妥協する必要があります。

簡単にUSBメモリーにバックアップする手順 robocopy

 バックアップは重要です。パソコンは絶対に壊れるので定期的にパソコンの外にバックアップする必要があります。もちろんバックアップ先も絶対に壊れるので同じと言えます。しかし、その2つが同時に故障する可能性は天文学的に低いです。 そう、同時にパソコンとバックアップしたUSBメモリが壊れ...