2012-02-22 10 views
1

私が働いているの割り当ては、のために尋ねる:Javadocを提供し、の生成Javadocの

合理的なインラインコードのドキュメント方法の説明、パラメータと戻り値の説明と、ドキュメントを生成しました。

ちょうど/ **ですか?それとも、Eclipseの生成版ですか?

答えて

4

彼らは、後でjavadocツールを使用してドキュメントを抽出できるように、コードが適切にコメントされるように要求しています。 Javadoc best practicesにすべて従ってください。また、余分なクレジットが必要な場合は、実際にドキュメントを生成するためにビルドのドキュメント段階を実行してください。彼らがそれを愛すると確信しています。

0

"Javadocで生成されたドキュメント"は、コード内の/**コメントから生成されたHTMLドキュメントになります。 EclipseにはEclipseの機能があるのか​​どうかはわかりませんが、一般的にはJDKに付属のjavadocコマンドラインツールを使って行います。

関連する問題