8

Web アプリケーションに多数のコンポーネントとサブコンポーネントがあるとします。追加したすべてのカスタム イベントの動作を追跡する必要があります。これらの行動を図示または文書化するための確立された方法はありますか?

ドキュメントに表示する必要がある事項は次のとおりです。

  1. さまざまなコンポーネントの関連する DOM 要素の実際のネスト。
  2. イベントの名前とその発生元。
  3. カスタム イベントに添付されたペイロード (たとえば、memoPrototype カスタム イベントのコンテンツ)。
  4. イベントが観察される場所。
  5. 他のイベントに応答してどのイベントが発生したかを示します。
  6. イベントのバブリングが許可される場所と停止される場所。
4

2 に答える 2

2

正直なところ、私はビジュアルモデラーが大好きでした。MSがVisioにそれをダンプしたとき、私は少しがっかりしました。

とはいえ、Visioは依然として優れたツールであり、コンポーネントのオブジェクトモデルを作成したり、イベント、プロパティ、メソッドなどを定義したりするために使用できます。UMLデザインなどの機能が組み込まれています。

しかし、私は最後に言わなければなりません、私は通常、メモ帳またはMSワードで終わります。ドキュメントの冗長性によっては、コンポーネントのメモや説明を入力することは、どの種類のDOMツールにもうまく適合しませんが、Wordドキュメント内の狂人のように太字、タブ、リスト、および斜体にすることができます。

悲しいように聞こえますが、それは本当です！

于 2009-05-21T13:31:15.027 に答える
2

Web アプリケーションのフロントエンドの文書化標準が確立されているという話は聞いたことがありません。

とはいえ、追跡したいアプリケーションのさまざまな側面を特定したので、この情報を各イベント ハンドラーの docblock に保持し、jsdoc ツールキットを使用してインライン ドキュメントを生成できます。

私見ですが、文書化したいことがすでにわかっているので、アプリや組織に完全に固有のものであっても、自分にとって最も意味のある形式で自由に文書化する必要があると思います。答えのないスタックオーバーフローで8時間は、標準的な答えがないことを意味する必要があります;)

于 2009-05-21T13:16:57.223 に答える