メソッドの先頭にコメントブロックを追加すると、メソッドが何を行うかについてのメモや、入出力パラメータのリストを追加するのに便利です。また、複雑なコードの中に数行の読みやすいテキストがあると、自分や他の人がそのコードの特定のセクションの目的を思い出すのに便利です。4D v18 からは、コメントブロックが追加され、あなたのプログラミング体験は、さらに充実しました。
コメントとは、ソースコード中のテキスト（メモ、説明、注意書きなど）で、コード実行中にコンパイラに無視されるように特別な文字で指定されています。コメントは、1行のコメントでも、複数行にまたがってもかまいません。このため、多くの行に// を付ける代わりに、/*をコメントの先頭に、*/ をコメントの末尾に付けてブロック全体をコメント化することができます。また、コメントを折りたたんだり、展開したりすることもできます。さらに、if 条件やループの内部でも、行の任意の部分にコメントを追加することができます。
コメントが重要な理由
- 複数の開発者が同じプロジェクトに参加しているチームでは、コードがきちんとコメントされていると、他の開発者がコードを理解しやすくなり、コードレビューやデバッグのプロセスが容易になります。
- 私たちは人間なので、物事を忘れるのは全く普通のことです。後でコードを見たり編集したりするときに、コメントがあれば、そのコードを書いているときに使った論理を思い出すのに役立ちます。たとえ本当に簡単なコードを書いたとしても、数ヶ月後、数年後にそれを読んでみてください。コメントをつけておけばよかったと思うでしょうか？