+- Curl Global Community (https://communities.curl.com)
+-- Forum: Discussions (https://communities.curl.com/forumdisplay.php?fid=1)
+--- Forum: General Curl questions (https://communities.curl.com/forumdisplay.php?fid=2)
+--- Thread: Curlのコメントについて (/showthread.php?tid=215)
Curlのコメントについて - usami - 08-18-2011
Curlのソース（クラス）にJavaDocのようなコメントをつけたいと思ってますが
みなさんはどのように付与しているのでしょうか？
JavaDocちっくに
|##
#
#|
のような感じでつけているのでしょうか？
また、CurlではJavaDocのようなものは生成できないのでしょうか？
RE: Curlのコメントについて - hokada - 08-18-2011
Curlでもjavadocみたいなことが可能です。ただし、javadocとは違いコメントではなく、ドキュメント用のマクロ（doc-nextなど）が用意されています。
Code:
{doc-next
{purpose 概要を記述します。}
{parameter v, 引数の説明をします。}
{details 詳細な説明を記述します。}
{notes 注意事項を記述します。}
}
{define-proc public {hello v:int}:void
|| ....
}この記述した内容をもとに、IDEからデプロイするときに、ドキュメントファイルを生成することができます。
また、そのドキュメントはCurl IDE ドキュメント上で見ることができたり、Eclipse上のツールチップとしても表示されるようになります。
Curl のヘルプに詳細は載っていますので、ご参照ください。
「Curl開発者ガイド」→「コンテンツの構成要素」→「アプリケーションの記述」
RE: Curlのコメントについて - usami - 08-18-2011
Curlブラケットでの記述はオブジェクトソースと混同しそうなのですが
eclipse上で見たときには記述内容が色分けされているのでまぁよいかなと。
JavaDocに慣れてしまっているとかなり違和感がありますが、これは慣れるしかないのでしょうね:-)
どうもありがとうございました。
RE: Curlのコメントについて - hokada - 08-18-2011
業務アプリケーション開発の現場で、共通部品ではなく、javadocのようなドキュメントを必要としない場合は、
以下のようにコメントで記述するケースは多いかもしれません。
Code:
|| -------------------------------------------------
|| .....
|| .....
|| -------------------------------------------------
or
||| -------------------------------------------------
||| .....
||| .....
||| -------------------------------------------------参考まで。