Edit in DokuwikiEdit in AsciidocEdit in Markdown

新しいdoclet

Gerald Boersmaによって作られた、強化された新しいdocletが利用可能になりました。

新しいdocletは既存のレガシー版よりも多くのオプションを備えています。

詳細はこちら

Edit in DokuwikiEdit in AsciidocEdit in Markdown

レガシー版Javadoc

javadocのツールがドキュメンテーションを生成する際、doc-filesディレクトリに含まれるすべてのファイルがjavadocにコピーされます(How to Write Doc Comments for the Javadoc Toolを参照)。

この機能を次のように利用することができます:

package net.demo1;
/**
* Demonstration for PlantUML.
* <p>
* Example of use:
* <p>
* <img src="doc-files/image1.png">
*/
/*
* @startuml doc-files/image1.png
* Bob -> Alice : hello
* Alice --> Bob : OK
* @enduml
*/
public class Demo1 {

}

javadocの前にPlantUMLを実行しておけば、doc-filesディレクトリにimage1.pngが生成されます。

その後でjavadocツールを実行することで、次の結果が得られます:

図の定義自体はjavadocではない通常のコメント内に書いてあることに注意してください。それはHTMLには出力されません。

このように、非常に簡単に、UMLダイアグラムをjavaドキュメンテーションに含めることができるようになりました。