第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>
ツールを使ったドキュメント作成技法（前編）（2/3） - ＠IT
特集：ツールを使ったドキュメント作成技法（前編） 価値のある開発ドキュメントを効率的に作成するには？ アバナード株式会社 市川 龍太（Microsoft MVP 2008 for XML） 2008/05/20 ■価値のあるドキュメントを作成するコツ ここからは価値のあるドキュメントを書くためのコツについて、いくつか紹介していく。 ●ドキュメントを書く目的を意識する ドキュメントを書く前に、そのドキュメントを書く目的を意識することは非常に重要である。つまりドキュメントを書く本当の目的が明確であれば、おのずと何を、どのように書けばよいのかが決まってくるのである。 例えば詳細設計書を作成する目的として、以下のような状況が想定され得る。 詳細設計書を基に実際の開発を行う 納品成果物に含まれているために必要（実際の開発ではそれほど参照されない） 運用・保守向けに必要 このうち、「詳細設計書を基に実
いますぐ始める RDoc によるドキュメント生成 - WebOS Goodies
先日公開した Ruby 用 JSON クラスを RubyForge にスニペットとして登録しました。使い方も書かないで登録しても意味がないので、この機会に今まで興味がありながら手が出せなかった RDoc を使ってみました。これがもう驚くほど簡単で、なんで今まで使わなかったのかー！！と後悔しきりです。そんなわけで、私のように食わず嫌いをしている方に向けて、「30 分で始める RDoc」を目標に（あくまで目標＾＾；）使い始めの手引きを書いてみました。まだ RDoc をご利用でない方、挑戦してみてはいかがでしょうか。 なお、すでに Ruby 一式がインストール済みで、最低限の Ruby の知識があることを前提にしていますので、あらかじめご了承ください。 まず最初に、 RDoc について軽くご紹介しておきます。すでにご存知の方は読み飛ばしてください。 RDoc は Ruby 専用のドキュメント生成
Adobe製、フリーのJavaScriptエディタプラグイン「JSEclipse」：CodeZine
Adobeは2日、Adobe Labsを通じてフリーのEclipse用JavaScriptエディタプラグイン「JSEclipse」をリリースした。今回のバージョンは「prerelease 2」となっている。 JSEclipseはAdobe Labsのサイトから無償でダウンロードすることができる。なお、ダウンロードするためにはAdobe IDの登録が必要。また、Eclipseプラグインであるため、Eclipseを使用できるようにしておくことが必要となる。 ダウンロードしたzip形式のファイルを解答し、pluginsフォルダ内の「com.interaktonline.jseclipse_1.5.5.jar」とfeaturesフォルダ内の「com.interaktonline.jseclipse_1.5.5.jar」ファイルを、それぞれEclipse本体のpluginsフォルダとfeatur
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
