|
Emphasis is was being put on providing tool documentation that
is suitable for template designers. To achive this goal, a documentation
format has been defined that captures all information relevant to the
template designer. It is being supplied in addition to the customary
Javadoc. This should help to achieve what we always claim for Velocity:
"Decouple the work of template designers from the work of software
developers". Look at the Struts
MessageTool
for a good example of the new documentation format.
テンプレートデザイナのためのツールドキュメントを提供することを重要視していますした。
これを実現するために、テンプレートデザイナに関係する全ての情報を網羅するドキュメント形式が定義されました。
これは、通常の Javadoc に加えて提供されます。
これによって、私たちがいつも Velocity に求めている事−
"テンプレートデザイナの仕事とソフトウェア開発者の仕事を分離せよ"
−を達成する手助けになるはずです。
新しいドキュメント形式については、Struts の
MessageTool
が良い例となっています。
Update:
While we value the look and readability of this format, we are presently
drifting away from the use of it. The primary reason for this is that the
developers have found it difficult to maintain (i.e. no one
has been motivated enough to put in the extra work). If you feel this
documentation format is valuable and wish to help us create and maintain
it for the various individual tools, please see
below
for more details on getting involved. Meanwhile, we'll be putting effort
into improving javadoc for individual tools and overview documents for
the sub-projects.
更新情報:
この形式の見栄えと可読性を重宝すると同時に、
私たちは現在その使用から遠のいています。
一番の理由は、開発者にとってメンテナンスしにくいからです。
(i.e. 誰も余分な作業をするほどの意欲がないのです。)
もしこの形式に価値があると判断し、様々なツールのドキュメントを作成し、
メンテナンスしたいと思いましたら、参加するための詳細について
下記 を参照して下さい。
当面は、各々のツールのjavadocの改善と、
サブプロジェクトのドキュメントの見直しを努力します。
|