一陣の神風が舞う EclipseでJavaDocを作ると文字化けしてしまうことがある
EclipseでJavaDocを作ろうとした時に困ったことの回避メモ。 ▼JavaDoc生成時に、文字コード`\65279`は不正だと怒られる JavaコードをUTF-8で作っていて、かつ人から引き継いだ時によく発生する。 これは、JavaDocツールがBOM有りUTF-8に対応していないから発生するらしい。 （ちなみに、Javaは対応） これはEclipseで直そうとするとハマるので、素直に外部ツールを使って `UTF-8`(BOM無し)に変換してやればいい。 |･x･)っ[ オススメ変換ツール ] ファイル検索で`*.java`見つけて、検索窓からファイルをまとめてドラッグ＆ドロップ。 速攻変換できるのでラクちん。 ▼出来上がったJavaDocをブラウザで見ると文字化けする 多分、出来上がったHTMLの文字コードが設定されていないため。 [エクスポート]->[Java:JavaDoc]
Eclipse 上で UTF-8 のソースから javadoc を生成する方法 - Be an Idealistic Realist
UTF-8 のソースからの javadoc 生成でおこられる Eclipse から javadoc を起動する際、ソースファイルをシステムのデフォルトエンコーディングで読み込もうとします。おいらの環境ではシステムのデフォルトエンコーディングが MS932 なのですが、ワークスペースのデフォルトエンコーディングを UTF-8 にしているため、javadoc 生成時におこられてしまいます。 javadocのオプション javadoc には、エンコーディングに関して以下のようなオプションがあります。 オプション 効果 -encoding ソースファイルのエンコーディングの名前 (EUCJIS/SJIS など) を指定します。このオプションが指定されていない場合は、プラットフォームのデフォルトコンバータが使われます。 -docencoding 生成される HTML ファイルのエンコーディングを指定
第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の生成
歴史のないJava言語の急速な普及には、「JavaDoc」という洗練されたドキュメント環境が大きく影響しています。そのいつも利用しているJavaDocは実は簡単に生成できます。ソースごとに対して記述しているコメント文を、いくつかの簡単な文法に従って記述すればそれがJavaDoc用のコメントとなります。当然ですがJavaDocはクラスの再利用のためのプロセスの大事な１ステップです。どんなに優れた再利用性を持つクラスでもソースを追わないと利用法がわからないのでは誰も「再利用」してくれません。ソースコードを記述する上で毎回毎回JavaDocを記述するのは、はっきりといって非常に骨の折れる作業ですが必ず記述してください。 では具体的にはどのように記述すればよいのでしょうか？下記のソースファイルとJavaDocを見て下さい。 AddressDataクラス → ソースファイル、JavaDoc ２つを見
javadocリファレンス
javadocってなんぞや？ インストールはどうするん？ まずはjavadoc用ソースファイルを用意せな。 ソースファイルの書き方。 コメント タグ 例 んじゃjavadocコマンドをつかってみんべ まずはヘルプ javadocの書式。 オプション。 @filesについて。 javadocってなんぞや？ javaのソースファイルの内容を解釈してリファレンスマニュアルを生成してくる便利なコマンド。この存在を知らずに手書きでレファレンスを書いた後にjavadocの存在を知ると本気で泣ける（経験者談） インストールはどうするん？ JDKがインストール済みならばすでにインストールされています。JDKインストールフォルダのbinフォルダ内に実行ファイルがあるはずです。 JDKすらインストールしていないという人はまずはSUNのWEBページからJDKを落としてインストールしてください。 また、インストー
Javadoc用のコメントの書き方
Version 1.0, 1997年9月18日, 川口 浩司 前書き JDKに付属している Javadoc というツールは、ソースリスト上のコメントから、自動的にドキュメントを作成してくれます。作成される書式は、APIのマニュアルと同じものです。 Javadocについては、Javasoftから以下のようなドキュメントが公開されています。（詳しくは Javadoc Home Page を参照してください） JDK付属の Javadocオンラインマニュアル How to Write Doc Comments for Javadoc The Java Language Specification (JLS) CHAPTER 18「Documentation Comments」 ここでは、これらのドキュメントを元に、日本語での応用例を含めて、コメントの書き方について自分なりにまとめてみました。 コ
簡単な Javadoc の書き方
Javadoc は Java2 SDK に付属しているドキュメント生成ツールである． これは Java ソースプログラムから特定の情報を抽出し， そのドキュメントを HTML 形式で生成する． Java API がその代表例である． まず，コメントを一切書いていない Java ソースプログラム Foo.java を Javadoc で処理してみる． すると図 1 のようなメッセージが表示され，12 個のファイルが生成される． $ javadoc Foo.java ソースファイル Foo.java を読み込んでいます... Javadoc 情報を構築しています... 標準 Doclet バージョン 1.4.1 constant-values.html の生成 全パッケージとクラスの階層ツリーを作成しています... 全パッケージとクラスのインデックスを作成しています... overvi
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Google Code Archive - Long-term storage for Google Code Project Hosting.