問題タブ [yuidoc]

ドキュメントのビルドプロセスメッセージをより便利にするために、yuidoc のさまざまなタグを無視することは可能ですか?

@author、@date などのタグに問題があります

そして、「本当の」警告を見つけることを不可能にするファイルがたくさんあります」 yuidoc でタグを除外する方法はありますか?

この 4 日間、yuidoc に JavaScript フレームワークを解析させようとしましたが、本当に頭がおかしくなり始めています。

ここに私のjson設定ファイルがあります

json 構成を解析しており、エラーはありません。出力は次のとおりです。

コマンドラインと出力とテーマのデフォルト設定を使用して動作させることができますが、プロジェクトのビルドとバージョン情報がありません。Bootstrap テーマは Github にあり、動作します。Windows 7 64 ビットで Cygwin 64 ビットを使用しています。

私は... - 行末をチェックしました - 最小限の編集で yuidocs の例をコピーして貼り付けました - あらゆる方法でコマンドラインを試しました - すべてのパスとディレクトリが存在することを確認しました

ヘルプ！エラーも出力もないのはなぜですか。

作業中の JavaScript プロジェクトに @date や @author などのカスタム プラグインを追加する必要があります。

ドキュメントの目的で yuidoc を使用しています。

しかし、ここには2つのケースがあります

1> @data タグが yuidoc にありません

2> @author タグはありますが、ドキュメントには表示されません

これは利用可能なタグのリストです

http://yui.github.io/yuidoc/syntax/

これらのタグをドキュメントに表示するにはどうすればよいですか?

カスタムタグを追加して yuidoc に表示する方法はありますか?

私はYUIdocを使用しています。他に何か ？Ember でモデル、コントローラー、ミックスイン、およびビューを適切に文書化する方法を誰か教えてもらえますか?

たとえば、私はこれを文書化しようとしています:

編集現在、jsdoc3 の代わりに YUIdoc を使用しています

@classYUIDocs のようなドキュメンテーション ツールを使用すると、コメント ブロックでタグを使用して、クラス (オブジェクト クラス) を識別および説明できます。識別された各クラスには、次のように定義された@staticorタグが必要です。@constructor

• @constructor- クラスがインスタンス化可能 (new キーワードで作成) であることを示します。
• @static- クラスを new でインスタンス化してはならないことを示します。クラスのすべてのメソッドを静的に呼び出すことができます。

Ember では、 を使用してサブクラスを作成することがよくありますextend()。私の知る限り、これはクラスの新しいインスタンスを作成しません。ただし、これらの定義の多く (ルートのコントローラーなど) は、定義に使用してもシングルトンですextend()。

したがって、私の質問は次のとおりです。ember アプリでクラスを文書化する一般的な状況では、@constructorvsを使用し@staticますか? そのような例は次のとおりです。

• 初期化子
• ルーター
• アダプター
• シリアライザー
• 変換
• ルート
• 店舗
• モデル
• コントローラー
• ビュー
• コンポーネント
• ミックスイン

Handlebars ヘルパーは実際にはクラスではなくメソッドであると信じているため、ここには含めませんが、間違っている場合はこの質問を修正します。