問題タブ [yuidoc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
2 に答える
2366 参照

javascript - メソッドの「オブジェクト」パラメータを文書化する方法

YUIDocを使用してJavaScriptメソッドのドキュメントを作成しようとしています。次のようになります。

options.idこれで、optionsオブジェクトは、、などのいくつかのパラメータを持つことができますoptions.single

この情報をこのドキュメントに追加するにはどうすればよい@paramですか?

0 投票する
2 に答える
104 参照

javascript - メソッドが yuidoc で {id: String, label: String} の配列を受け入れることを確認するにはどうすればよいですか?

ドキュメントで見つけられません。

私が好むのは[{id: String, label: String}]、生成されたドキュメントに型を表示することです.実験の結果、私ができる唯一のことは、他の文字なしで単一の英数字のみの文字列を指定することであると思いました(ジェネレーターによって無視されます)。

それを行う方法は本当にありませんか?

0 投票する
1 に答える
272 参照

javascript - yuidoc - 別のファイルでクラス メソッドを定義する方法

yuidoc でドキュメントを書いています。ただし、別の場所でメソッドの 1 つが定義されているクラス Model があります。状況を視覚化するためのコードを次に示します。ファイル model.js があるとします。

そしてファイルactiverecord.js:

ご覧のとおり、「hasMany」メソッドがモデルのクラス ドキュメントの下に表示されます。しかし、そうではありません。このようなことは可能ですか?

どうもありがとう

0 投票する
2 に答える
684 参照

yuidoc - yuidoc の IgnorePath を追加するにはどうすればよいですか

ドキュメント フォーム yuidoc を生成する際に、プロジェクトの lib フォルダー内にダウンロードされた JavaScript ライブラリを無視したいと考えています。それを無視リストに 入れるにはどうすればいいですか "ignorePaths": [ "./lib" ]"ignorePaths": [ "./lib/*.js" ]"ignorePaths": [ "lib" ]

それでも、JavaScript ライブラリ ファイルをコンパイルします。

0 投票する
1 に答える
403 参照

javascript - Yuidoc : パラメータの性質を指定します

node.js モジュールを yuidoc ( http://yui.github.io/yuidoc/ ) で文書化しようとしていますが、パラメーターからその実装へのリンクを作成する方法を考えています。

私が次のものを持っているとしましょうsrc/core/Repo.js

そして、src/routing/Routes.js

yuidoc に html ドキュメントで正しいハイパーリンクを生成させるために、Routes関数がオブジェクトを引数に取るようにするにはどうすればよいですか? Repo(上記のスニペットは機能していないようです)

0 投票する
1 に答える
160 参照

ruby - Ruby で Yuidoc スタイルのコメント?

RubyでYUIDocコメントを使用するにはどうすればよいですか? 私が思いつくことができる最高のものはこれです:

この:

0 投票する
0 に答える
110 参照

javascript - YuiDoc でオーバーロードされたメソッドを文書化する方法は?

クラス foo に、すべてのオプション パラメータを受け入れるメソッド bar を持つメソッドがあるとしますが、パラメータと順序が変更されると、メソッドの戻り値が大幅に変更されます。

yuidoc でこのメソッドを呼び出すさまざまな方法をどのように表すことができますか?

オプションのパラメーターは問題ありませんが、メソッドの説明は、すべてをそこに入れると少し長くなります。

0 投票する
1 に答える
240 参照

javascript - ANT スクリプトで yuidoc を使用して JavaScript ドキュメントを生成する

yuidoc を使用して JavaScript ドキュメントを生成しようとしています。以下は私の ANT スクリプトです。

私のプロジェクトは次のようになります

Android プロジェクトのスクリーンショット

ANTスクリプトの実行中にエラーが発生しました:

0 投票する
2 に答える
280 参照

windows - ANT スクリプトが機能しない

コマンドラインから yuidoc を実行する ANT スクリプトがありますが、このスクリプトを実行すると以下のエラーが表示されます。

同じコマンド -> yuidoc -c yuidoc.json 。動作したら、cmdプロンプトで実行します。

私のANTスクリプト: