Java API仕様を作成する with CPad for Java

Java API仕様書(Javaドキュメント）は、クラスがどのような役割、クラスメンバ・インスタンスメンバを提供しているかを示すためのhtmlドキュメントです。他のC/C++と違ってAPI仕様をhtmlで簡単に公開できるのも、Reusablity（再利用）、Readablity（読みやすさ）を重視しているからでしょう。API仕様は、もちろん自分のためでもありますが、何よりも、あるクラスを利用するユーザー（プログラマ）のために、公開されます。自分で作ったクラスを利用するユーザーが自分の時もありますが、大規模プログラムになりますと、自分が書いたクラスは、全く意志の疎通をとっていない他のユーザーが利用したりしますので、利用しやすいようにクラス・パッケージの解説をしておかなければなりません。クラスの仕様を人間のわかる言葉（日本語・英語等）を使って表現したのが、javaドキュメントです。

まずは、例として、BankAccount.java、BankUserInterface.java、TestBankAccount.javaをダウンロードしてください。その３つのファイルをCPad for Javaで開きます。

CPad for Javaのメニューの『ツール』→『パッケージのドキュメント生成』を選びます。

※『ツール』→『ドキュメントの生成』を選びますと、アクティブになっているウインドウのjavaファイルだけ読み込まれます。

すると、同じフォルダ内のjavaファイルが読み込まれ、自動的に、htmlベースのAPI仕様ができあがります。

最後にhtmlに関連ずけられたブラウザが立ち上がり、フォルダ内にあるすべてのクラスのAPI仕様が表示されます。

開いたブラウザの左側の各クラスをクリックすると各クラスの詳細をみることができます。

TIPS1:Java API仕様で表示されるコメントは、/** */でくくられたコメントです。javadocには特有の@で始まるタグがデフォルトで用意されています。主立ったものは、Javaで珈琲ブレイクで紹介しておりますのでご覧ください。

TIPS2: version 2.316現在、デフォルトでprivateメンバが表示されるようになっております。privateメンバを表示しないメニューはありません。ですので、普通にprivateメンバを表示しないようにするには、CPadのコマンドバーから

#javadoc *.java

と入力し、Enterキーを押しますと、privateメンバなしのAPI仕様を作成できます。