- 締切済み
コメントの記入の仕方
先輩（既にいませんが）のマイコンのプログラムを見てコメントが全部英文（または英単語）で書いてあり「これ本人わかるのか？」と思いました。それも部分によっては一行ごとに記入してあるのでかなり見難い。 コメントはプログラムを理解しやすくする為に記述するものかと思うのですが書いてある内容を理解するよりアセンブラの本文を理解するほうが早いのでは？と思う始末。 実際にコメントはどちらで書く事が多いのでしょう？私自身それほど熟練では無いので日本語コメントの方がありがたいですが。（簡単な単語は別ですけど。） 日本語コメントだと変換がめんどくさいでしょうけど。 ちなみにその先輩はプログラマーが本業ではありません。
- poyo3
- お礼率66% (538/813)
- その他（プログラミング・開発）
- 回答数5
- ありがとう数5
- みんなの回答 （5）
- 専門家の回答
みんなの回答
- KCTW
- ベストアンサー率38% (15/39)
- nekonokota
- ベストアンサー率45% (27/59)
私が行ったCOBOLの現場で、コメントは、 ---------------------- ○○を××する 85.02.07 Ver.1 作成者 ---------------------- こんだけ。っていうケースがありました。その後ソースが150行ぐらい。 辞めましたけど（笑） 統合開発環境（身近なところで行くと、Visual C# Express Editionとかかな）は、自作のクラスのメソッドなどに、所定の方式のコメントを入れる（XML文を記入する、のが正しいのか？）と、その自作クラスを使うときに、入力補完ができるようになったりしているので、つけておいて大損する、と言うことはないと思います。 私は鳥頭（≒３歩くと忘れる）なので、多少の手間がかかっても、入れるようにしています。 （現ホビープログラマより）
お礼
回答ありがとうございます。あまりに少なすぎるのも問題ですね。 コメント記入もプログラム同様に個性なんでしょうか。
- buriburi3
- ベストアンサー率44% (353/792)
自分で作ったプログラムでも半年、1年、2年とたてば内容なんぞサッパリ覚えてなくて他人が作ったも同然の状態になります。 コードを読めば何をやってるかわかるような事をコメントに書く必要は無いです。 コードを読んでも分からないであろう事情や意図を書いておくと良いです。
お礼
時間経つと覚えていないですよね。少なくとも見出しくらいはわかるように書いてくれよというくらいわかり難いもので、目を通す気にもならないくらいでしたから。 要点だけですよね。回答ありがとうございます。
まあ普通は日本語で書くでしょうけど、マイコンだと開発環境によってはASCII文字しか使えないこともあり得るので、その場合はいやでも英語で書くしかないでしょうね。ローマ字という手もありますけど、それじゃあどっちもどっちな気が… コメントは自分が解ることがまず優先、他人のことは考えないのがありがちなパターンですが、そうすると得てして、時間が経つと自分にも解らなくなります。「なんて解りにくいことしてんだよ、昔の俺」っていう悲しい（しかしよくある）オチになります。 中には日本人なのに、コメントは全てロシア語で書くという変人もいるようですが、やはりコメントは他人に読まれることを前提として書くべきでしょうね。
お礼
やはり日本語の方がわかりやすいですよね。 確かにコメントに時間を割くのも馬鹿らしいので多少手抜きで後からなんだっけ・・という事はありますけど。 他人がわかるように書くことを心がけたほうがいいですね。 回答ありがとうございます。
- trajaa
- ベストアンサー率22% (2662/11921)
誰のためのコメントか？でしょう。 自分自身の為なら自分自身が見やすければ何でもアリだろうけど。 既に居ないと言うことは引き継いだと言うことか？ 引き継ぐと言うことは、個人的になモノでなく業務としてなのかな？ なら、自分以外には分からないようなコメントは意味が無いですね。 まあ、マイコンとの事、アセンブラとの事ですから 普通の業務系とは、同列には語れない点はあるにしても・・・・ コメントには、初期定義の意味とか、処理分岐の意味とかコードステップ単行よりも上のレベルでの概略が掴めるようなのが必要 あまり細かく書かれても、それじゃ各行を逐次解釈するのと一緒ですなぁ と、私は思うけど。
お礼
まずは自分でわかるようにですよね。ただあまりにも見難いので本人もわかるのかなと思うのです。（あまりできる人ではなかったのでカッコつけて書いていたのかなとも思いますけど） 肝心な部分にコメントが少なくどうでもいいような部分に一杯かいてあるので余計にです。回答ありがとうございます。
関連するQ&A
- 組み込みプログラマ
制御系（マイコン）のプログラマに就職が決まった大学生です。 現在、アセンブラの勉強をしています。 今まで、Ｚ８０、ＰＩＣの経験があります。 しかし、Ｃ言語で組み込み系のプログラムを書いたことはありません。 そこで、実際に組み込み系で働いておられる方に質問があります。 １．現在のマイコンではＣ言語が主流ですか？ ２．アセンブラだけでは食っていけませんか？ ３．組み込み系は寿命が長いと聞いたことがあるのですが、 本当でしょうか？
- ベストアンサー
- その他（プログラミング・開発）
- コメント 中国語 日本語
中国語OSで動かすためのプログラムをPHPで書いています。 そのプログラム内で日本語でコメントを入れたいのですが、正常に動作しますか？ よろしくお願いいたします。
- ベストアンサー
- PHP
- 理解不能なコメント…
海外にお住まいの方から、コメントをいただいたきました。 日本語で書いてあるのですが、文の組み立てがおかしかったり、ひとりよがりな描き方をされていて、コメントの後半の内容が理解不能なんです。 迷惑コメントというわけではなさそうなので、お返事をしようと思うのですが、この場合、どうやってお返事すればいいでしょうか？ 自分が考えているのは、次の３通りのやり方です。 １．前半の意味の分かる部分にだけ触れて、後半の理解不能な部分には触れないでおく。 ２．「後半部分は私の読解力不足で理解できませんでした。」 と、自分に非があるような言い回しをする。 ３．「後半部分であなたがおっしゃっている意味が分かりません。」 と相手に非がある旨を伝える。 返事をする場合、１～３のどの方法が適していると思われますか？ それとも返事をしない方がいいのでしょうか。 もしくは、上で挙げた以外で、「こんな風に返事をしたらいいよ」 というのがあれば教えてください。 ※海外にお住まいの方ですが、日本語が母語でない方が慣れない日本語で一生懸命書いてくださったのか、日本語が母語であるけれども表現の下手な方なのか、判別できませんでした。ですが、なんとなく後者かな、と思います。中学生ぐらいの女の子ではないかと。
- ベストアンサー
- ブログ
- AVRマイコンのCコンパイラについて
PCでは、Cやアセンブラの経験もそこそこある本職のプログラマですが、マイコンは初心者です。 AVRマイコンに興味がわいて、早速使ってみたのですが、 開発環境は、AtmelStudio6と、AVRStudio4の両方を試しています。 どちらの開発環境も、ライブラリ関数のリファレンスがどこにあるのか わからない状況です。 サンプルをみると、_delay_ms()などの関数とincludeファイルがいくつかあるので、 ライブラリ関数がないわけではなさそうです。 ネットで検索しても、ライブラリ関数のリファレンスに相当するものをみつけられません。 AVR達人の方、どこに情報があるのか教えて頂けると幸いです。 情報は日本語が望ましいですが、英語でも構いません。 よろしくお願いします。
- ベストアンサー
- その他([技術者向] コンピューター)
- weiboコメント中の１文の和訳をお願いします
中国語を勉強し始めたばかりの初学者です。 weiboのコメントの中で、教えていただきたい１行があります。 「不谈论这个你是我心中的女神，说到这个没办法高兴！」の１文です。 weiboでフォロワーの多い日本人の女性が、南京大虐殺記念日翌日に天皇に関するコメントをし、中国の方からいろいろなコメントが寄せられたコメントの中の一つです。 1個1個の単語を調べましたが、どうしても文としてうまく解釈ができません。 どうぞよろしくお願いいたします。
- ベストアンサー
- 中国語
- 漢字のコメントをはずすとコンパイルできる
Visual Stadio 2008 の C++ で以下の簡単なプログラムをコンパイルすると、 error C2059: 構文エラー : 'else' error C2059: 構文エラー : 'return' error C2059: 構文エラー : '}' のようにエラーが出ます。 ------------- #include <stdio.h> int main(int argc, char** argv) { // 引数が指定されていた場合 if( argc == 2 ){ printf("引数があります"); }else{ printf("引数がありません"); } return 0; } ---------- いろいろ試してみたところ、 ・コメントをはずすと、コンパイルできる ・ソースリストはUTF-8である ・同内容をShiftJISで記載すると、コンパイルできる ことに気がつき、 「UTF-8の日本語コメントを、コメントとして正しく認識していない」らしい ことが原因らしいところまでわかりました。 で質問になりますが、 「UTF-8の日本語コメントを、コメントとして認識させる」 ためには、どうしたらよいのかお教えください。
- 締切済み
- C・C++・C#
- FC2ブログのコメントの画像認証の数字化
FC2ブログを利用しています。 画像認証がひらがななため、 日本語をタイプできる人を除いてコメントを残せない状態にあります。 コメントの画像認証を日本語から数字に変更するにはどうしたらよいか ご存知の方いましたら教えて頂けませんか。 http://paro2day.blog122.fc2.com/blog-entry-665.html この記事を見つけて読んだのですがよく理解できません。 宜しくお願いします。
- 締切済み
- ブログ
- こういう英語の勉強の意味は？
私の学校で宿題があるのですが、その内容について意味があるのか、面倒なだけじゃないのか。と感じているのですが、意見を教えて欲しいです。 英語 予習が大事。先に教科書の本文を「ノートに書き写して」、わからない単語、文法を調べる。そして「ノートに日本語訳も書く」 わからない単語文法を調べるのはとてもいいことだとおもいますが、 本文や訳を書くのは意味ありますか？面倒で、やる気が続かない理由にしかならないと思います。 頭のなかで本文訳したほうが良くないですか？そもそも英語の本文書いて頭に入りますか？私は入りません。気が滅入るだけです。 教科書にわからないところを書けばいいじゃないですか。 はたして、こういう宿題に意味があるのでしょうか？高校生になったばかりでよくわかりません。なので本文を写す価値や日本語訳をわざわざ書き込む意味を教えていただきたいです！つたない文章ですみません
- ベストアンサー
- 英語
- word 2007での文字数指定の方法
word 2007での文字数の指定の方法が分かりません。 A4一枚に英単語300語に設定したいのですが、どのようにやればよいのでしょうか？日本語で一行につき40行などの設定方法はわかるのですが。 詳しい方教えてください。
- ベストアンサー
- オフィス系ソフト
- 3.5MBちかくのテキスト辞書の扱い
日本語１語が一行づつおいてあるテキスト辞書をプログラムでよびだす際、一回一回このファイルをopenすべきか、メモリにかきこんでしまうべきかまよっています。 プログラムの呼出側では何百回、何千回と辞書の頭から最後まで単語を検索する可能性があります。一語一語をfgetsをつかって読みこむか、char* 配列[300000]程度確保し、mallocをつかって読みこんだ文字列を格納したメモリ領域の先頭をこの配列に代入して、次からの呼出しはメモリでおこなえるようにするか。。。。 メモリを消費するのは断然後者だとは重いますが、どちらがいい方法といえるでしょうか。
- ベストアンサー
- C・C++・C#
お礼
確かに英語がぺらぺらなら何も気にする事ないですよね・・。 その辺の問題なのかもしれないですね。回答ありがとうございます。