ソースコードに説明を付け加える方法は3つあります。複数行に渡るコメント、改行まで続くコメント、1行内に埋込むことができるコメント、の三つです。
複数行に渡るコメントは、(*で始め、*)で終わります。これらはMopsで定義されたワードであるため、空白文字以外の文字が隣接していてはいけません。別のワードとみなされてしまいます。したがって、コメントの内容とこれらの記号との間には、少なくとも一つの空白文字が必要です。なお、このコメントは入れ子にすることもできます。
改行まで続くコメントは、バックスラッシュで始まります。\ ですが、エディターによってはYenマークになっていることもあるでしょう。英文フォントでは左上から右下への斜線です。これもMopsで定義されたワードであるため、空白文字でない文字が隣接することはできません。バックスラッシュ[半角空白またはタブ]のあと改行されるまでコメントとみなされます。
一行内に埋込むコメントは、( で始め、) で終わります。開始の括弧はワードですから、空白文字でない文字が隣接することは許されませんが、終わりの括弧はワードではなく単なる区切り文字ですから、空白文字以外の文字が隣接してもかまいません(外観上は、隙間を空けた方がよいでしょうが)。閉じ括弧より後には、普通にコードを続けることができます。なお、複数行コメント用のワード(* *)でも、一行内にコメントを埋込むことはできます。
コメントはコードではなく、コンパイラはコメント部分を一貫して無視します。しかし、コメントはコードに匹敵する重要性を持ちます。複数人で開発する場合やソースコードを配付する場合はもちろん、個人的にプログラミングする場合であっても、コーディングミスを防ぐことと保守を可能にすることのためには、適切なコメントをすることは不可欠とさえいえます。
Mops/Forthで特に重要なのはスタック効果コメントです。これは、関数(ワード)定義に際して、そのワードが何個のスタックアイテムを消費し、結果としての値を何個残すかをコメント書きするものです。Mops/Forthでは名前のある変数を用いずに、スタックに値を預けることが多いため、この種のコメントがないと、スタックの状態(残された値)を見失ってしまう危険があるからです。
関連項目:
最終更新:2018年12月10日 19:59