2012-01-17 8 views
0

各コードサンプルに個別にデシジョンを追加したいと思います。例:JSDocで各サンプルに個別にデシジョンを追加してください

/** 
* Test function, normal desciption 
* 
* THE DESCRIPTION OF THE EXAMPLE HERE 
* @example 
* fooBar("foo", "bar"); 
* 
* THE DESCRIPTION OF ANOTHER EXAMPLE HERE 
* @example 
* fooBar("bar", "foo", false); 
*/ 
function fooBar (param1, param2, param3) { 
} 

これはJSDocで実行できますか?もしそうなら、どうですか?

答えて

0

http://code.google.com/p/jsdoc-toolkit/wiki/TagExampleの下の注によると、

HTMLマークアップを使用して複雑なサンプルブロックを作成し、<code>を使用して実際のサンプルコードを引用することができます。 Description部分はHTMLの中に入れても構いませんが、<code>の外に置くことができます。

+0

ありがとうございます!しかし、私はもっと「ネイティブ」なアプローチを探していました。たぶん、JSDocなどにタグがあるかもしれません。 – Fredefl

関連する問題