JavaDoc を Doclava で生成するようにしたら捗った - mallowlabsの備忘録
Java のドキュメントと言えば JavaDoc ですが 見た目があまりにもダサ過ぎやしませんかね？ こんなんじゃ JavaDoc を書くモチベーションが下がってしまいます。 そこで JavaDoc を Doclava で生成するようにしました。 Google Code Archive - Long-term storage for Google Code Project Hosting. するとこんな風に今時のかっこいいデザインで出力されます。 検索ボックスは、パッケージ名とクラス名を インクリメンタル検索ができて機能的にも便利です。 使い方 Maven で使う場合には reporting 要素の下に以下のように書きます。 <reporting> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifac
Javadocにクラス図 - torutkのブログ
一昨日、id:torutk:20110119で、Javadocにシーケンス図を埋め込む方法を書きましたが、次はクラス図を埋め込みたくなります。 ということで、まずは調査フェーズから。 Javadocにクラス図を埋め込むツールを探す UMLGraph（BSDライセンス） APIviz（LGPL） UMLGraph http://www.umlgraph.org/ 定番と言えるツールで、あちこちで言及されています。 万人のためのオートメーション: プッシュボタンによるドキュメント作成 http://java.dzone.com/articles/reverse-engineer-source-code-u?page=1 日本語が化ける問題があって回避方法の言及が以下URLにあります。 http://blog.livedoor.jp/fitskater/archives/20231.html 別
Javadoc生成ドキュメントにシーケンス図（Quick Sequence Diagram Editor) - torutkのブログ
クラス仕様をJavadocでドキュメント化すると、ときおりシーケンス図を載せたくなる場合があります。 DoxygenではMscgen: A Message Sequence Chart Rendererというツールがあってコメント中にテキストでシーケンス図の定義を書くと、ドキュメント生成時に画像ファイルを生成しドキュメント中に画像リンクを追加してくれる機能がありました。 Javadocの場合は、Quick Sequence Diagram Editor - Summaryというツールがあり、Javadocコメント中にテキストでシーケンス図の定義を書くと、HTMLドキュメント生成時に画像ファイルを生成し、HTML中に画像リンクを追加してくれる機能があります。 Javadocのタグレットとして動作するので、Javadocコマンドのオプションで指定します。 http://sdedit.sourc
javafxdoc-style docs for Java code - marsのメモ
http://blogs.sun.com/sundararajan/entry/javafxdoc_style_docs_for_java JavaFXのドキュメントジェネレータ(javafxdoc)をJavadocのdocletに指定して，JavaFX APIのようなカッチョええJavadocを生成してみたよ的な話。 ちなみに，こんなの。 つい最近，「そろそろ標準docletはどうにかして欲しい」と思ってただけに，とてもタイムリー。使い方は簡単。JavaFXをインスコして，$JAVAFX_HOME/lib/sharedからjavafxc.jarとjavafxdoc.jarを引っこ抜く。あとは，これをdocletに指定するだけ。 コマンドラインは面倒臭いんで，Antの定義部を示す（パスとかはテキトウに読み替えて）。 <target name="javafxdoc"> <javadoc so
第1回 Javadocリファレンス | gihyo.jp
※ javadocコマンドの-overviewオプションで指定するため、任意の名前で作成できます。 概要コメントファイル アプリケーションまたはパッケージセットに対してのコメントファイルです（リスト1、図3）。概要コメントファイルはHTMLファイルとして作成します。公開ドキュメント用と内部向けドキュメント用の2つの概要コメントファイルを切り替えて使うことをお勧めします。 リスト1 概要コメントファイル（overview.html） <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <title></title> <meta http-equiv="Content-Type" content="text/html; charset=Shift_JIS"> </head> <body>
『エンジニアのためのJavadoc再入門講座 現場で使えるAPI仕様書の作り方』 - 暫停使用
9 冊目の著作となる本書は、ある意味私らしい「ややズレた」スタイルの書籍となりました。6/29 発売ですが、池袋ジュンク堂では本日先行入荷したそうです。 ちなみに、サブタイトルは「現場で使える API 仕様書の作り方」。Javadoc をテーマとした書籍は、恐らく世界初ではないかと。 エンジニアのためのJavadoc再入門講座 現場で使えるAPI仕様書の作り方 作者: 佐藤竜一出版社/メーカー: 翔泳社発売日: 2009/06/30メディア: 単行本（ソフトカバー）購入: 15人 クリック: 263回この商品を含むブログ (49件) を見る 本書は、意味のある Javadoc(ドキュメンテーションコメント)をほとんど見たことがないという現実を何とかしようと思って書きました。確かに、多くの Java のソースコードにはドキュメンテーションコメントが記述されています。しかし、その多くは「メソッ
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Google Code Archive - Long-term storage for Google Code Project Hosting.
Google Code Archive - Long-term storage for Google Code Project Hosting.
http://d.hatena.ne.jp/happy_ryo/20090118
IBM Developer