2009-07-01
自分も相当なJavadoc厨と自負しておりますので，内容をあらためねばと超上から目線で立ち読みしてきたら，{@code}タグやら@{literal}タグなど，知らないタグが書いてあって，恥ずかしい思いをしたでありますの巻。 慢心はいけませんね。:-P 今までJavadocの書き方といえば「How to Write Doc Comments for the Javadoc Tool」くらいで，とっても良いこと書いてあるのに読んでくれる人は少なくて悲しい思いをしたもんだが，日本語で解説してある本書がでたから，もう安心だね。遠慮して「再入門講座」ってあるけど「再」は余計だよね，つーか，みんなJavadocナメ過ぎ。あれは，相当デキる子なんですよ。 思い返せば，うんこなJavadoc（を作っているプロジェクト）に対する不満は山のようにあるが，そんなの書いてもしようがないので，「Javadoc，よく
Javadocを書く - しげるメモ
最近は時間を作ってEffective Javaの2版をよんでます。 Effective Java (Java Series) 作者: Joshua Bloch出版社/メーカー: Prentice Hall発売日: 2008/05/08メディア: ペーパーバック購入: 6人 クリック: 65回この商品を含むブログ (42件) を見る ほとんど1版と同じ内容ですが、"Item 44: Write doc comments for all exposed API elements" を読んでよくまとまってるなと思ったので、触発されてメモがてらに私のやり方を。 引用の2段落目は基本的に超約。 どこに書くか If an API is to be usable, it must be documented. ユーザが利用可能なすべてのAPIにJavadocを書く。 これはとりあえず必須だと思います。ち
パッケージのjavadocドキュメントを書くには
javadocはJDKに付属するドキュメント生成ツールです。 このツールを使うことで、ソースコード中に記載した/** */形式のドキュメントから、 標準APIのドキュメントと 同じ形式のHTMLファイルを生成してくれます。 Javaのオープンソースのプロダクトなどでもこのjavadocで生成したドキュメントが提供されることが多いですね。 EclipseなどのIDEではメソッド上にカーソルを置くだけでチップヘルプ形式で javadocコメントを表示してくれたりするので、書いておいて損はありません。 パッケージのドキュメント javadocにはパッケージに対してのドキュメントも存在します。 (例：java.langパッケージ) 自分のソースでこれを表示させたい場合は、パッケージ配下にpackage.htmlというHTMLファイルを書くのが 古来よりの習わしでした。Java5.0になるまでは。
html2winhelp
2006/4/4 Ver.1.5.0 & ソース。 修正点： Java 5.0 対応 文字コード判定を強化 インデックス情報をテンポラルファイルに書き出すことで、メモリ消費量を押さえた href=... が、入力のトップディレクトリよりも上のディレクトリを参照しようとしている場合に、出力に含めないようにした。このチェックは完全ではありません。 タグの開始でないのに「<」が出現した場合などで HTML Help Workshop が文句を言うので、次の文字が英字でなければ「<」に修正などするようにした。（HTMLの正しい解釈法ではないかもしれません） Ver.1.0.0 & ソース。 はじめに html2winhelp は、javadoc によって出力された html を Windows の HTML Help のソースへ変換します。出力されるソースは、Microsoft の HTML
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
EclipseでJavadoc作成 - 気の向くままに・・・
http://google-guice.googlecode.com/svn/trunk/javadoc/index.html
