J2C アプリケーションでのドックレットの使用

J2C アプリケーションの Java™ ソース・コードにタグを追加することによって 、J2C ドックレット機能を使用することができます。

ドックレット・タグは注釈プログラミング・タグです。J2EE 環境でのデプロイの準備が整った アプリケーション成果物の生成について拡張可能な処理方法を提供します。 J2C アプリケーションの Java ソース・コードにドックレット・タグを追加するときに、 これらの成果物が自動的に生成されます (CTRL-S を押して保管した後で)。
ドックレット・タグは、Javadoc スタイルのコメント として Java ソースに 挿入されます。 注釈ベース・プログラミング・タグの属性には、有効範囲 (コード内でタグが存在する場所) と 多重度 (タグを使用できる頻度) が含まれています。

サポートされるドックレット・タグ:

以下のタイプのタグが使用可能であり、 J2C アプリケーションの開発時に Java ソース・コードに追加できます。
  1. 有効範囲 有効範囲とは、Java ソース・ファイル内での タグのロケーションを意味します。 有効範囲には、パッケージ、クラス、メソッド、およびフィールドの 4 つのオプションがあります。
    • パッケージ

      パッケージ・コメントに追加されます。 この有効範囲では、Java パッケージ全体、モジュール全体、またはアプリケーション全体に適用可能な 情報が提供されます。

    • クラス

      クラス・コメントに追加されます。 この有効範囲では、Java タイプ全体またはインターフェース全体に関する情報が提供されます。

    • メソッド

      クラス内の特定のメソッドのコメントに追加されます。 この有効範囲では、クラス内で参照されているメソッドについての情報が提供されます。

    • フィールド

      クラス内の特定のフィールドのコメントに追加されます。 この有効範囲では、クラス内で参照されているフィールドに固有の情報が提供されます。

  2. 多重度: 多重度とは、特定のタグが 1 つの Java ソース・ファイル内に出現する回数を意味します。 ドックレット表記では、多重度は、タグ名の後の括弧内で示されます。
    • 0..1: Java ソース・ファイル内 で、タグが 0 または 1 回使用されることを示します。
    • 0..n: Java ソース・ファイル内で、タグが 0 回から無限回まで使用されることを示します。
サンプル: 以下のサンプルは、IMS™ Multisegment Output チュートリアルから引用したものです。
  1. 「プロジェクト・エクスプローラー」ビューでプロジェクトを展開し、「Java リソース」を展開し、「JavaSource」セクションを展開します。
  2. パッケージ (この場合は、sample.ims) を右クリックし、「新規」> 「クラス」を選択して、新規クラス・ウィザードを起動します。
  3. クラスの名前として CCIBuffer と入力します。 すべてのデフォルト設定を受け入れます。
  4. 終了」をクリックします。 Java エディターで CCIBuffer クラス が開きます。
  5. CCIBuffer クラスのコメント・セクションで、この方法でタグ @type-descriptor.message-buffer を追加します。
    ドックレット・タグの追加
  6. Ctrl-S キーを押して、変更を保管します。CCIBuffer.java クラス・ファイルに、以下のコードが自動的に生成されます。
    /*
      * Created on Oct 13, 2004
     *
      * TODO To change the template for this generated file go to
      * Window - Preferences - Java - Code Style - Code Templates
     */
    package sample.ims;
    
    /**
      * @author ivyho
     *
      * TODO To change the template for this generated type comment go to
      * Window - Preferences - Java - Code Style - Code Templates
      * @type-descriptor.message-buffer
     */
    public class CCIBuffer implements javax.resource.cci.Record,
    		javax.resource.cci.Streamable, com.ibm.etools.marshall.RecordBytes {
    
    	private byte[] buffer_ = null;
    
    	/**
    	 * @generated
    	 */
    	public CCIBuffer() {
    		return;
    	}
    
    	/**
    	 * @generated
    	 * @see javax.resource.cci.Record#getRecordShortDescription()
    	 */
    	public String getRecordShortDescription() {
    		return (this.getClass().getName());
    	}
    
    	/**
    	 * @generated
    	 * @see javax.resource.cci.Record#hashCode()
    	 */
    	public int hashCode() {
    		return (super.hashCode());
    	}
    
    	/**
    	 * @generated
    	 * @see javax.resource.cci.Streamable#write(OutputStream)
    	 */
    	public void write(java.io.OutputStream outputStream)
    			throws java.io.IOException {
    		outputStream.write(buffer_);
    	}
    
    	/**
    	 * @generated
    	 * @see javax.resource.cci.Record#setRecordShortDescription(String)
    	 */
    	public void setRecordShortDescription(String shortDescription) {
    		return;
    	}
    
    	/**
    	 * @generated
    	 */
    	public int getSize() {
    		if (buffer_ != null)
    			return (buffer_.length);
    		else
    			return (0);
    	}
    
    	/**
    	 * @generated
    	 * @see java.lang.Object#toString
    	 */
    	public String toString() {
    		StringBuffer sb = new StringBuffer(super.toString());
    		sb.append("¥n");
    		com.ibm.etools.marshall.util.ConversionUtils.dumpBytes(sb, buffer_);
    		return (sb.toString());
    	}
    
    	/**
    	 * @generated
    	 * @see javax.resource.cci.Record#getRecordName()
    	 */
    	public String getRecordName() {
    		return (this.getClass().getName());
    	}
    
    	/**
    	 * @generated
    	 */
    	public byte[] getBytes() {
    		return (buffer_);
    	}
    
    	/**
    	 * @generated
    	 * @see javax.resource.cci.Record#clone()
    	 */
    	public Object clone() throws CloneNotSupportedException {
    		return (super.clone());
    	}
    
    	/**
    	 * @generated
    	 * @see javax.resource.cci.Record#setRecordName(String)
    	 */
    	public void setRecordName(String recordName) {
    		return;
    	}
    
    	/**
    	 * @generated
    	 * @see javax.resource.cci.Record#equals()
    	 */
    	public boolean equals(Object object) {
    		return (super.equals(object));
    	}
    
    	/**
    	 * @generated
    	 * @see javax.resource.cci.Streamable#read(InputStream)
    	 */
    	public void read(java.io.InputStream inputStream)
    			throws java.io.IOException {
    		byte[] input = new byte[inputStream.available()];
    		inputStream.read(input);
    		buffer_ = input;
    	}
    
    	/**
    	 * @generated
    	 */
    	public void setBytes(byte[] bytes) {
    		buffer_ = bytes;
    	}
    
    }
ご利用条件 | フィードバック
(C) Copyright IBM Corporation 2000, 2005. All Rights Reserved.
(C) Copyright IBM Japan 2005.