日本語でのJavaDocの書き方 - 水まんじゅう2
JavaDocを何で書くの？とか、書き方とかをまとめたページはたくさんありますが、日本語特有の情報が抜け落ちていたり、英語でのJavaDocの書き方を説明するものばかりなので、日本語特有の情報をいくつか書きたいと思います。 なお、JDK 8u144あたりでの挙動です。将来では変わるかもしれません。 JavaDocの書き方の一般的なものを知りたい場合は公式のマニュアルを見るのが一番良いと思います。 https://docs.oracle.com/javase/jp/8/docs/technotes/tools/windows/javadoc.html サマリー文の後は2つ改行を入れましょう。 /** * 一行目はサマリー文としてその処理(クラス、メソッド等)の概要として扱われます。 * * <p>英語では行末に「.」(ピリオド)が入り、JavaDocではピリオドまでを1行目のサマリーとして扱
Windows上のVSCodeのLanguage Support for JavaでJavaDocを見たときに文字化けする - 水まんじゅう2
VSCodeのLanguage Support for JavaでJavaDocを参照しようとしたときに文字化けすることがあります。 ファイルのエンコードがUTF-8で書かれている場合などです。 WindowsではデフォルトのファイルのエンコーディングがWindows-31Jですが、Language Support for Javaでは開かれているファイルのエンコーディングではなく、OSのエンコーディングを見に行ってしまうため、文字化けが発生します。 解消方法としてはオプションに以下の記述を追加してあげるだけです。 "java.jdt.ls.vmargs": "${すでに存在するこのオプションの設定} -Dfile.encoding=UTF-8"
Javadocに何を書こうか - 日々常々
これは Java Advent Calendar 2015 の 16 日目の記事です。 昨日は @yukung さんの Java で引数の null チェックで迷った話 でした。明日は @mdstoy さんです。 ちなみに過去のJavaアドベントカレンダーで書いたもの。 2014年: Javaであまりしないコーディング 2012年: Date and Time APIを触ってみた 2011年: JUnitの知識を棚卸し #JJUG ……2013年は書いてないのか。そうか。 前置き 3年前になりますが、コメントについては書いたことがあります。 http://irof.hateblo.jp/entry/20121104/p1 たまにスライド見返したりするのだけれど、今でもそれほど主張は変わらない感じです。 で、先に挙げた記事はインラインコメントがメインとなっていますので、 今回はドキュメントコ
日本語 Java SE 8 API ドキュメント URL 変更につきまして
日本語 Java SE 8 API ドキュメント URL 変更につきまして 2015年3月10日 at 5:10 午後 皆様 いつも大変お世話になっております。 現在、Java SE 8 に関連したドキュメントを大幅に更新を掛けております。 http://docs.oracle.com/javase/jp/8/ その過程で、Java SE 8 API ドキュメントへのリンクが下記に変更されました。 旧：http://docs.oracle.com/javase/jp/8/api/ 新：http://docs.oracle.com/javase/jp/8/docs/api/ これは、USのオリジナルのドキュメントがディレクトリ構成を変更したためで、USに併せて日本でも今後、上記のURLが正しいURLとなります。つきましては、大変恐れ入りますが、上記に対して現在ブックマークされている場合は改め
いまさら聞けない「Javadoc」と「アノテーション」入門
よく使う3つの標準アノテーション型 アノテーションをソースコードへ埋め込むためには、コンパイラがチェックできるように、どんなアノテーションを使うのかをアノテーション型として最初に定義しておく必要があります。開発者は定義されているアノテーション型を使って、注釈を付けたいクラス、メソッド、変数などにアノテーションを付けます。 Javaには標準アノテーション型として、java.langパッケージに「Override」「Deprecated」「SuppressWarnings」が定義されています。これらは、よく使いますし、分かりやすいので、具体的にどういった使い方をすればいいのか、確認してみましょう。概要は、次の通りです（下記リストはインデックスになっています）。
[Android Tips] Eclipseからjavadocを正常に出力させるためのパラメータ 【小ネタ】 | DevelopersIO
javadoc EclipseでJavadocを出力する際にすんなりと行かなかったので、記録しておきます。 環境 OS : Windows 7 Professional 64bit JDK : jdk 1.7.0_05 Eclipse : Eclipse 4.2 JUNO Javadocを出力する手順は簡単で、File > Export > Javadoc を選んであとはナビゲーションに従うだけなのですが。何も考えずにやると D:\dev\git\Sample\jp\classmethod\android\sample\Sample.java:7: この文字は、エンコーディング MS932 にマップできません。 /** 蜃ｦ逅?ｵ先棡 */ .... エラー 100 個 怒られます。 これはプロジェクトの設定をUTF-8デフォルトに設定しているので、文字エンコーディングでエラーが起きている
![[Android Tips] Eclipseからjavadocを正常に出力させるためのパラメータ 【小ネタ】 | DevelopersIO](https://cdn-ak-scissors.b.st-hatena.com/image/square/6135155a4de9035a33550843d5136f482918718b/height=288;version=1;width=512/https%3A%2F%2Fdevio2023-media.developers.io%2Fwp-content%2Fuploads%2F2013%2F09%2Ftool.png)
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
さよならsun.comのつづき 2012-03-26 - marsのメモ
（追記）日本語Javadocが従来通りオンラインで参照できるようになったようです。 → 続：旧 Java SE API リファレンスへの新しいリンク先変更について | 寺田 佳央 - Yoshio Terada それでも、oracle.comから探しに行くと見つからないので気をつけてね（日本語Javadocは、日本オラクルの管理なんだそうな。 java.sun.comにアクセスできなくなる事について、ちょっと気になることがあったので寺田さんに聞いてみました。 なるほど、whoisでsun.com調べてみると"Record expires on 20-Mar-2017"だし、確かに java.sun.com にアクセスするとwww.oracle.com/technetwork/java/ にリダイレクトされる。 とりあえず、次のURIは見えるのを確認しました（でも、なんか不安定なのよね。 h
Java SE API(JavaDoc)日本語訳は、オンラインで読めます。 - 地平線に行く
各所で、Java SE API(JavaDoc)日本語訳のオンライン公開終了が話題になっています。 rip-sun.com - Togetter 新しい Java SE API リファレンスの入手先について « 寺田 佳央 – Yoshio Terada しかし、今のところ以下のURLからオンラインで読めます（2012/03/26現在）。 概要 (Java Platform SE 6) JDK 6 ドキュメント なぜ java.sun.com が運用終了になったことに伴い、そのドメイン配下にあった Java SE API(JavaDoc)日本語訳も公開終了となってしまいました。 そのため、ダウンロードしてオフラインで読むようにという話だったんですが…。 java.net 上で行われている jdk-api-localizations プロジェクトのビルドファイルは依然としてアクセス可能です。
新しい Java SE API リファレンスの入手先について
新しい Java SE API リファレンスの入手先について 2012年3月25日 at 10:30 午後 3件のコメント 2012 年 03 月 25 日、sun.com のドメインが利用不可になりました。これに併せ、java.sun.com で提供されていた Java SE API 日本語ドキュメントもオンライン経由で参照する事ができなくなりました。今後、日本語の Java SE API レファレンスはオンライン経由では参照できなくなりますので、アーカイブを御入手の上、ローカル環境でご参照ください。お手数をお掛けし申し訳ございませんが、どうぞ宜しくお願いします。 Java API の日本語ドキュメントはコチラから入手が可能です。 ドキュメントの再配布ポリシーはコチラをご参照ください。 新しい日本語 API ドキュメントのオンライン参照先URL (2012/4/11 訂正、追記) htt
いまさら聞けない「Javadoc」と「アノテーション」入門
いまさら聞けない「Javadoc」と「アノテーション」入門：【改訂版】Eclipseではじめるプログラミング（22）（1/4 ページ） これからプログラミングを学習したい方、Javaは難しそうでとっつきづらいという方のためのJavaプログラミング超入門連載です。最新のEclipseとJava 6を使い大幅に情報量を増やした、連載「Eclipseではじめるプログラミング」の改訂版となります 注釈とコメントで開発しやすくしよう 開発者がソースコードにコメントを自由に記述すると、統一性がなくなり、同じ内容をさまざまな表現で書いてしまいます。これを防ぎ、重要な情報について統一的な表現で記述したいときは、「アノテーション（annotation、注釈）」を使うことを検討してみましょう。 Javaではアノテーションをプログラムのソースコードへプログラムのメタデータとして記述できます。また、プログラムにア
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
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
日本語JavaDoc(Java SE6/7) - 水まんじゅう2