お久しぶりです。今(1年前から)大切な時期なのでなかなかプチコンがでない自分です。久しぶりにチョコっとRPGのプログラムを見たら見にくくて訳ワカメでした。今更ですがコメントのテクを教えてください！

個人的には、 ・DEFの1行上に関数名と引数 ・FORループにループの内容 ・プログラム先頭に開発進捗メモ ですかねぇ…

改めて自分の見たら、教えて頂いた部分全てにコメント無かったです… これで制作スピードUPしそうです！

コメントのことではないんですけど、 たとえば「操作系の処理」とか、 「ダメージ計算の処理」とか、 「計算したダメージを表示に反映する処理」とか、 それぞれの処理のカタマリをサブルーチン化するとプログラムが整頓されてスッキリするよ、って話を聞いたことがあります。

あと、途中で短期的に 製作をストップせざるを 得なくなったときには その行またはプログラムの先頭に その旨を追記してますね。 (蛇足かな…？)

ボクの場合全部の行にコメントを付けるように心がけていますが、それは面倒な上に逆効果な場合もあるので特に大事な部分を挙げると ･変数を宣言したときに、変数の内容をコメント ･DEFの内容 ･ループの内容、終了条件 ･IFの条件 辺りが重要だと思います。

コメント多用派です！以下のことを心掛けると比較的大きなプログラムでもどうにかなる…かもしれません(・u・) ・見やすいようにコメントの縦をなるべく揃える(28文字目から〜とか) ・処理の区切りやメインループの端は罫線コメントで目立たせてパッと見でわかるように ・宣言時、全ての変数に何のための変数かコメントを入れる ・複雑な計算や、後で見たら何に使っていたか忘れそうな一時変数はコメントで補足 ・やり残しや不安要素がある部分には特定の記号を入れて検索性を上げる 大体こんな感じでやってますー( ´ u ` )

僕は基本的に注釈は 積極的には付けないかなぁ。 数十行以上あるようなある程度でかい 部分に処理の内容を大雑把に書く くらいはするけど。 あとは、途中で作業を中断するときは ’!!!と打っておくくらいかな。 理想であれば、注釈があんまりなくても なんとなく読めるような綺麗な プログラムを書いておけば いいんだと思うけど。

SPの定義,管理番号や 各変数の役割をはっきりさせて おくのも重要だったり。

プログラムの中身を知るためのコメント。 ・VARの後にコメント。 ・DEFに渡す値と返ってくる値をコメント。 これが書けないと自分のプログラムをよく分かってない可能性がある。(人の事言えない) プログラムを読みやすくするためのコメント。 記事の見出しのように大まかな処理の区切りあたりに目立つように書く。 場合によっては記号とかで囲ったり 効率よく作るためのコメント 検索機能で目的の部分にジャンプするために一意の文字列を入れたりする そんなところかな

皆さん色々な事を心掛けているんですね… すごく感心します。

自分は今作っているプログラムを 後になって改造しやすいように とりあえず使った変数の用途を全部 書いてみたり IF文の意味を書いたりしてます

プログラムそのものよりコメントはその人の価値観とかバックグラウンドとか滲み出るよね… 俺はコメントはあまり書かない派（メモリが足りないので 特にプチコンは日本語入力つらいので。 縦をそろえたり、空白を多用したりして見た目にきれいにしてるのは驚くけど別にそれほど役に立たないなぁって思ってる派。 ぷちぷち氏のいうようにコメントも種類ある。 なので分類ごとになんか共通の記号や仕様があるとうれしいんだけど。 作りかけの部分は「'!!!」 関数は「DEFの前にコメントを。」 みたいな。

スマイルツールを改造して、 L押しっぱなしで起動することで りゅうまご氏の「RMG_IME」を 起動できるようにしてあります。

漢字混じりのコメントがしやすい

そういえば、プチコンはソースコードのサイズがメモリ使用量に直結してるみたいだから、ガンガンコメント入れる、ってのもちょっと躊躇しちゃうとこありますね。 私がやるのは、ENDIFとかNEXTとかUNTILとかWENDとか、その始まりが画面内に収まってないくらい離れてるときは、そのENDIFとかにコメント付けとくかな。あとは大体みなさんおっしゃってるような感じ。特に変数にコメント付けとくのは大事だと思う。 あとはREMと'シングルクォーテーションで見た目違うのを利用してみるとか(逆に見辛くなるかも^^;)。

コメントは使い方によってはごちゃごちゃのスパゲッティの素になるからね 俺はコメント(無駄コード)だらけでスパゲッティ

普通、コメントを書くときはアポストロフィ( ` ←コレ)を使いますが、REMという隠し命令を使うことでコメントが緑色ではなく、本来の色のままになります。そのため、ヘルプの参照も可能です。

昔のコードをコメントで残す。って使い方もあるけど、そういう事やると、かえって読みにくくなるね。 基本、過去には振り返らない。 昔のコード残すなら、コメントで残すのは良くないって、個人的に思ってる

↑俺昔のコードを残してるからスパゲッティ

「昔のコード」という概念でなく、 「古いバージョン」として いくつか保存すれば回避できそうです。 SDの容量大変ですけどね

↑残りブロック5の俺どうしよう 鯖に上げよう

えっ、ソースコードのサイズでメモリ減っちゃうんですかー(・д・) 実行時は中間コードに直されてコメント類は排除されるのかと思っていました。どんなことになっているんだろう。。。 あ、縦を揃えたり罫線使ったり、っていうのは、目的の処理にスクロールするまでプログラムを一切読まないため、にやってます(・u・) 読み仮名みたいなものなので、プログラムが読める人にとっては無駄な手間かもしれませんー。

NEWしたらFREEMEM増えたので、ソースコードがスロットに存在してる時点で、そのサイズ分メモリ消費されてるんだろうなぁと思ってました。 プログラムにも依るだろうけど、よっぽどメモリいっぱいいっぱい使っていない限り、コメントでメモリ圧迫されるとかは気にしなくても大丈夫だと思います。

コメントの量が変わってもFREEMEMは変わらないと思いますよ。一応確認のためコメント10000行のコード作ってみても変化は見られませんでしたし。プログラムバッファはスロット毎に2MBなので、一行50文字みっちり書いて2万行超えそうな人はコメント控えた方がいいかも:)

ありゃ、勘違いしてたようで、失礼しました。 プログラムスロットと実行時に使われるメモリ共通だと思い込んでました。ちゃんと分かれてる見たいですね。 ＃何かでFREEMEM増えるの見た気がしたんだけど ＃スマイルボタンがらみだったかな。

僕は 使い捨てのコードにはコメントをつけない。長く付き合っていきたいコード、他の人に理解して欲しいコードにはコメントをつける派です。 以前、改造して欲しいならもっとコメントがわかりやすいと良いですね（意訳）、とコメントを頂いたのも、とても印象に残っています。 長いお付き合いになると、コメントと実際が違って振り回されることもあるし、コメントって悩みますよね。

コメントで重要なのは「何のためにコメントを記述するのか」ということです。 「他人に分かるようにする」「自分に分かるようにする」など様々な理由が考えられますが、他人と一言で言っても初心者相手なのか自分たちのチーム内で共有したいことなのかによって大きく変わります。 また「過去の自分は他人」とよく言われますが、自分が昔（下手すれば数ヶ月前）に書いたプログラムでも何でこんな処理をしているのかというのが分からなくなる場合があります。その際にもコメントがあると分かりやすくなります。 　A=1 'Aという名前の箱に1を入れる こんなコメントはプログラミング経験ゼロの初心者に見せるプログラムであれば意味がありますが、そうでなければ全く意味がありません。 したがって、コメントの有無が重要ではなくどこにどんなコメントをするかが重要であり、その部分を恐らく知りたがっているのかと思います。

コメントというのは多すぎるとそれでプログラムが逆に読みにくくなるため要所要所に記述するのがベターだと思います。 したがって、その「要所要所がどこか」というのがコメントを記述する際に重要になる部分です。 これは客観的な判断が難しいため作っている本人がここは重要な部分という所でいいと思います。 これは変数の定義だったり、自作関数であったり重要な部分は人それぞれなので この私の文章のように長文の割りに中身がないコメントをプログラムに記述するよりも簡潔な方が良いかなと私は思います。 私はコメントは書かない派というのもありますが、「どんなコメントを書いたらよいのか分からない」のであれば「コメントを書かない」という選択もありだと思います。 むしろ、コメントを記述するよりも分かりやすいプログラムを心がける方が結果的によかったりするかもしれません。（自分に合ったやり方でどうぞ）

世の中には２通りの人間がいると思うのです。 プログラムを書く際に「日本語で思いついてプログラム言語に翻訳する人」と「プログラム言語が先に思いついて、日本語に翻訳する人」の2通りです。 前者はコメントをモリモリ書いていく人が多数でしょうけど、後者はどうしてもコメントが少なくなってしまうのではと。 後者の人たちは下手をすると日本語で書いてあるより、プログラム言語で書かれている方が早く読めたりするわけで。 コメントがロジックと乖離していればなおさらで、コメントが返って思考の邪魔になってしまうのではと。 そのため、「第三者に公開する必要性のある」「ロジックが抽象的」「煩雑な変数」「TODOとして」など、日本語が先に思いつく人よりコメントをつける必然性ができるタイミング少ないと予想するわけで。

うん、アルファベットや数字が並んでるのを見ると それだけでもう嫌になってくる。 せめて変数名にひらがなが使えたらなぁと常々思います。

コメントをつけるテクニックということですが、コメントをつけるタイミングを御自分なりに整理してみては如何でしょうか。 最初に日本語で思考してプログラム言語に翻訳されるタイプの開発であれば、一通りの流れを日本語で書いてからプログラムを載せておく方が後々に、すんなり読めるでしょうし。 逆の開発手法であれば、「記述内容を思い出せるちょっとしたメモ」の方が思考の邪魔にならなくて良いと思うわけで。 コメントをロジックの上に書く、横に書く、下に書くなど皆さん一言はあるとは思うのですが、結局の所　ルールに沿って書いてあれば　後々読むことはできるわけで。ルールを思い出せないような書き方はよしておいた方がいいよね　と。 私個人としてはケースバイケースで。どちらかというとコメントは少ない方です。

とても参考になるコメントが色々あり、感動しました。 今後プログラムを作るときに、教えて頂いたことを実践していき、自分に一番あうやり方を見つけいこうと思います。 沢山のコメントありがとうございました。