This is pre-release software, please bear with it. This book is produced by the Wikbook tool. Wikbook is an open source project for converting wiki files into a set of docbook files.
So You Want Developers to Your API? Miredot generates REST API documentation straight from your existing Java sources! Always up-to-date docs without the effort — No More Documentation Drift Miredot generates your documentation with each build so it is guaranteed to correspond to the implementation at all times. We only need your existing Java source code. You don't need to add anything!
新しい 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
I have been on several teams where we studiously designed UML diagrams at the beginning of the project. As the project progressed, and deadlines approached, the UML diagrams were left somewhere behind, not to be updated in months. When a new developer joined the team, we showcased the old UML diagrams, and kept telling "Oh, we never had time to update them, please see the source code to get an ide
PlantUMLはJava製のオープンソース・ソフトウェア。UMLを作図するツールは幾つか存在するが、最大の難点だと思っているのがテキストベースでの記述ができないことだ。UMIと呼ばれるXMLベースの記述形式もあるが、普及している気はしない。都度重たいビジュアルエディタを立ち上げて編集するなんてのは面倒だ。 Wordに埋め込みのUML図 またドキュメントを作成するツールと、UMLを作成するツールが分かれてしまっているのも問題だ。そのためドキュメントの内容と図がずれていても気付きづらい。そんな問題を解決してくれるかも知れないのがPlantUMLだ。 PlantUMLはJava製のオープンソース・ソフトウェアで、テキストベースのUML記述を画像にコンパイルしてくれるソフトウェアだ。ユースケース、シーケンス、クラス、アクティビティ、コンポーネント、ステータス図に対応しているので十分だろう。 日本
こんな感じでいい気がしてきた。 http://.../svn/sample/ | |--trunk/ | |--tools/ JDK, Ant, Eclipse, Tomcat, DBなどのツール類 | |--doc/ ドキュメント類 | |--sample-project/ 各プロジェクトのビルドスクリプトを呼び出す大元のビルドスクリプト | |--build.properties |--build.xml | |--build-test.properties |--build-test.xml | |--conf/ Eclipseの設定ファイル(epfファイル)などを格納する | |--sample-common/ 共通的に用いられるユーティリティクラスなどの置き場 | |--build.properties |--build.xml |--.classpath |--.project
みなさん、Javadoc 書いてますか? Javadoc は「API ドキュメント」と言われることが多いように、主にライブラリ的なプログラムで書いてこそのものだと思っている方もいるかもしれません。しかしながら、仕様書を Word や Excel(笑)で別途作ると、プログラムと仕様書の同期がとれてないというはめに陥り易くなりますので、Javadoc はどんなときも活用したいというのが私の考え方です。 まず、overview.html を書け Javadoc コメントをいくらか書くような人でも、overview.html を書く人は意外と少ないのではないでしょうか。リファクタリングが何度となく行われるアジャイル開発の現場では、クラスの構成がよくかわりますので、いちいち詳しいコメントを書いていられないということはあるかもしれませんが、overview.html はそれほど何度も手をつけるようなも
JAutodoc is an Eclipse Plugin for automatically adding Javadoc and file headers to your source code. It optionally generates initial comments from element name by using Velocity templates for Javadoc and file headers. Features JAutodoc has the following features: Mode Complete existing Javadoc Existing Javadoc will not be touched. Only missing tags will be added and so far undocumented elements wi
最近は時間を作って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を書く。 これはとりあえず必須だと思います。ち
これは Apache Tomcat サーブレット/JSP コンテナの 文書一式のトップレベルの入り口です。 Apache Tomcat version 5.5 は Java Community Process による Servlet 2.4 と JavaServer Pages 2.0 の仕様を実装しています。 さらに,多くの追加機能を含めることにより,自らを Web アプリケーションと Web サービスを開発し配置するための 有用なプラットフォームにしています。 (左側にある) ナビゲーション・メニューからリンクのひとつを選んで進むと, より詳しい文書を入手できます。 以下,入手できる各マニュアルについて,より詳しく述べます。 The following documents are aimed at System Administrators who are responsible fo
We’re getting things ready Loading your experience… This won’t take long.
株式会社野村総合研究所(以下NRI)は、オープンソースに関連したマニュアル・利用ガイドなどの一般技術資料を本サイトにて公開しています。NRIでは、社内のノウハウを積極的に公開することにより、オープンソースの健全な発展に貢献したいと考えております。 NRIではこれまでに社内R&Dで評価したオープンソースを自社製品である「ObjectWorks+」の開発環境に取り込む活動を行ってきました。現在、ObjectWorks+では国内における普及を鑑み、オープンソースの開発環境であるEclipseを標準開発環境として取り込んでPluginの開発や日本語の利用ガイドを作成しています。さらに、標準的な開発環境としてEclipseが日本国内で広く普及することを願って、これらの社内向けドキュメントを社外にも公開しています。 現在、公開しているドキュメントはEclipseを使ってWebアプリケーションを開
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く