Tips

メソッド毎に簡単な説明が付けられます

日付2003/09/11
ID29483 (英語原文参照)
バージョン6.8.x / 2003.x
プラットフォームMac & Win

“メソッドコメント”機能は、1993年、4D Insider 1.0と共にリリースされました。それは、メソッドに対して“コメント”を付加出来る機能でした。
ここで言うところの“コメント”とは、メソッド中に残す「`」記号で始まる行のことではありません。実際、4D Insider 1.0の頃のこの機能の呼び名は“Documentation”でした。4D Insiderの中で、Documentationの付いたメソッドにはアンダーラインが付いて表示されていました。

バージョン6.5からは、このコメントはデザインモードエクスプローラの中で直接表示出来るようになりました。メソッドコメントを表示させる操作手順は、まずエクスプローラからメソッドを選び、右側に広げられるプレビューペインの上部にある「コメント」ラジオボタンを選択しますと、コメント文が表示されます。

また、お望みでしたらをa href="http://www.4d.com/4DLINK/4DACTION/Web_Solutions/Show.4DTechTip?tCaseID=4780">「自動コメントシステム」活用することも可能です。

4D 2003からは、メソッドコメントはSOAPメソッドと共に活用されるようにもなりました。SOAPメソッドを公開した場合、その内容を説明したドキュメントをWSDLとして提供出来ます。通常、その中では、そのメソッドの利用方法等が語られています。4D 2003では、この部分にメソッドコメントを活用します。具体的にはSOAPメソッドとして公開したメソッドのコメントの先頭255バイトをWSDLとして公開しています。