2017-04-17 8 views
2

これは間違った質問ですが、jsdocで作業を開始したばかりで、docファイルを生成しようとする際に問題が発生しています。jsdocで@paramを使う方法

私は本質的に同じように見えるいくつかの例をオンラインで見つけましたが、何らかの理由で私が文書化したい変数のドキュメントを生成できません。

これは私のコードです。

/** 
*@fileOverview mainController ' main controller file' 
*@param Controller here 
*/ 
function (jQuery, Controller, JSONModel, Filter){ 
    ..... 
    } 

@paramは、index.htmlファイルはそれについて何の情報も表示されませんしないと、私はエラーを見ていない作品@fileOverview最初の部分。 私は間違いなくここに何か間違ったことをやっているが、私は何

+0

と@param Controllerのような記述はここにありますか? – peteb

+0

は動作しません。以前は@param Controllerを試してみましたが、うまくいきませんでした。また、「@fileOverview」はコメントとして緑色で表示され、「@param」は青色で表示されていることに気付きました。依存関係などにjsdocを含める必要がありますか? – polaris

答えて

2

これを試してみて知っていない:あなたは、パラメータ名の間にハイフンを置くしようとしたことがあり

/** 
* @fileOverview mainController ' main controller file' 
* @param {object} Controller here 
*/ 
function (jQuery, Controller, JSONModel, Filter){ 
..... 
} 

(間隔の変化に注意してください)

+0

が動作しませんでした。ドキュメントはまっすぐに見えるし、私がやっていることはそれを行う方法だと思われる – polaris

+0

私はドキュメントを理解していないと思うが、私は以下を試してみたが、動作するようだ。 /** * '@fileOverview mainController' 'メインコントローラファイル' * '@constructorは' * '@paramをコメント{オブジェクト}コントローラーここ */ 機能(jQueryの、コントローラ、JSONModel、フィルタ)を{ .....} I index.htmlを呼び出す関数を展開してそのパラメータを見ることができます – polaris

関連する問題