2017-06-26 27 views
7

私の状況は、JavaDocsを持たないサードパーティの外部コンパイル済みライブラリ(jar)です。私が開発しているように、私は第三者のウェブサイトから入手した非常に限られたドキュメントをテストして使用することによってクラスとメソッドを文書化したいと思っています。外部ライブラリのJavaDocsを書き込む

私の最終目標は、コードヒントとドキュメントの参照のためにIntelliJで使用できるJavaDocドキュメントを用意することです。

私の質問は、JavaDocsを私がインポートできる、すでにコンパイルされたjarファイルに書き込むことができますか?おそらく、これを支援するツールを使用します。

答えて

4

はいです。すべてのメソッドが抽象クラスであるかのように、コード、のないクラスとインタフェース、メソッド、および変数定義を書き出し、それらに対してJavadocのコメントを書いてください。これは、実際に、SunがJavadocを、テクニカルライターと編集者(hi Doug!)によって制御された完全に別のソースツリーを介して、ソースコードをリリースするビルドプロセスの後半でマージプロセスを用いてどのように生成したかです。

+0

クイックコードの例を表示できますか?あなたの答えをより明確にするのに役立ちます。 – byxor

+0

メソッドを抽象的であるかのように、単に 'abstract'キーワードなしで、つまりメソッド本体ではなくセミコロンだけで書き出します。あなたはそれをコンパイルすることはできませんが、あなたはそれをJavadocできます。 – EJP

+0

これはうまくいった!私はこれのための別々のプロジェクトを作成し、あなたが言ったようにしました。プロジェクトにはエラーがたくさんありますが、JavaDocジェネレータには問題はありません。私のメインプロジェクトでは、ドキュメントを添付して、それは魅力的に機能しました。ありがとうございました :) – JensV

関連する問題