4

Groovy または Java のクラスまたはメソッドの場合、API レベルのドキュメントは通常、通常のコメントではなくドキュメント コメント (別名 Javadoc コメント) に含めます。Groovy スクリプトについてそのようなコメントを追加する類似の方法は何ですか?

個人的には、Javadoc ツールがドキュメントを取得するかどうかはあまり気にしません。ただし、Groovy スクリプトの目的に関するドキュメントは、クラスのドキュメント コメントに概念的に類似しているように見えます。したがって、私は直感的にそれらがドキュメントのコメントにあると期待しています。私の直感が間違っていて、doc タグが Groovy スクリプトの意図をコメントする標準的な方法ではない場合、スクリプトの目的を文書化するための推奨される方法は何ですか?

4

1 に答える 1