[seasar-javadoc:757] Re: SingletonS2ContainerFactory

O.Goto seasar @ yzr.skr.jp
2007年 1月 7日 (日) 21:55:30 JST


後藤(goto)です。

On Sat, 06 Jan 2007 22:00:52 +0900
Koichi Kobayashi <koichik @ improvement.jp> wrote:

> 
> > ExternalContextComponentDefRegisterに日本語名が当てられていなかったので、
> > 「外部コンテキストコンポーネント定義レジスタ」としましたが、なんだかよくわからない名前になってしまいました。
> 
> Jundo さんは
> 「外部コンテキスト用コンポーネント定義を登録するためのオブジェクト」
> としてますね.
> 
Jundoさんにあわせてみました。でも文章の中にこの表記があると、???って感じが。
やっぱりExternalContextComponentDefRegisterの日本語名称があると書きやすいかなって思います。
でもいい名称がつくれません。

「外部コンテキスト用コンポーネント定義登録オブジェクト」
「外部コンテキスト用コンポーネント定義登録クラス」

なんか違うような・・・

自分自身以外での表記名称として、
「〜Deployer」は「〜デプロイヤ」、「〜Customizer」は「〜カスタマイザ」と、既に記述があります。
一方、「〜Register」、「〜Creator」、「〜Aware」、「〜Assembler」あたりはまだこれからで、
Javadocを書く上で今後困りそうな感じです。

上記の例にならうと、「〜Register」を単純にカタカナにして、

「外部コンテキスト用コンポーネント定義レジスタ」

とか。
私が最初に書いたやつに「用」がついただけだ・・・


> ■クラスコメント
> 
> >  * クラスローダ内で唯一の{@link org.seasar.framework.container.S2Container S2コンテナ}を提供するためのファクトリクラスです。
> 
> 「クラスローダ内で」は正しいのですが,これを書くとどの
> クラスローダなのか書かないといけないような.
> 出だしではクラスローダを外して「唯一の」で始めて,後の段落で
> 「SingletonS2ContainerFactoryをロードしたクラスローダで唯一」と
> 説明してもイイかも.
> 
出だしの「クラスローダ内で」を外して説明を付け加えました。


> >  * シングルトンS2コンテナファクトリは、設定ファイルに基づいたS2コンテナの生成・初期化を行い、それを保持します。
> 
> 「設定ファイルに基づいた」は「設定ファイルに基づいて」の方が
> いいような.ちょっと自信なし.
> 
振舞いをあらわすという意味では確かに「基づいて」の方がいい感じがします。


> それから,利用手順としてアプリケーション開始時 (Web アプリなら
> Servlet#init()) に init() を呼び出してから getContainer() して,
> アプリケーション終了時 (Web アプリなら Servlet#destroy()) に
> destroy() するように書いておいてください.
> 時々 init() を呼び出さずに使う人がいたりするので.
> 
クラスコメントに入れました。


みなさまコメントお願いします。
-------------- next part --------------
テキスト形式以外の添付ファイルを保管しました...
ファイル名: SingletonS2ContainerFactory.java
型:         application/octet-stream
サイズ:     7555 バイト
説明:       無し
URL:        http://ml.seasar.org/archives/seasar-javadoc/attachments/20070107/71a4962d/attachment.obj 


seasar-javadoc メーリングリストの案内