2012-01-12 11 views
15

JavascriptのJavaDocsのようなものがありますか?私がnetbeans IDEでctrl +スペースを押しているときにJavascriptのドキュメント

JavaScriptを書くと、指定されたオブジェクトのjavascriptのドキュメントが出てきます。しかし、このドキュメントは、私はNetbeansのプロパティを推測しています。

JavaScriptを適切なコメント形式で書くと、NetbeansはカスタムJavaScript用のドキュメントも作成します。

Netbeansの外部でこのようなjavascriptのドキュメントを見つけることはできますか?私たちはそれを参照することができるように?

お返事ありがとうございます。しかし、私はタブがないこと怖い

答えて

11

は、静的な参照のためのMozilla開発者向けネットワーク(MDN)でのドキュメントのページを見てくださいIDE内で使用可能な完全機能。

+0

正確に必要なもの。 – Acn

+9

Google検索のヒント:javascript用語の後に "mdn"を追加します(例: "substr mdn")。対応するMDNページがほとんど常に最初の検索結果になります。 – nnnnnn

+1

私はIDE内のJsDoc(Javadocish)のタブ補完をあきらめません。 WebStormは彼らがそれをサポートしていると言います:http://stackoverflow.com/questions/11076572/seeking-example-of-how-to-use-jsdoc-with-the-webstorm-ide-v-4 – SimplGy

8

Googleのホームページのdoodlesのソースコードでは、javadocのコメントとよく似たコメントを使用しているため、少なくともGoogleが使用する標準がなければなりません。ここで

は一例です:

/** 
* Configuration for a simulator speed setting. 
* - stepTime: ms between simulation steps that do something. 
* - emptyStepTime: ms between no-op steps. 
* - tapeTime: ms for a tape operation. 
* - branchTime: ms for a branch operation. 
* @typedef {{stepTime: number, tapeTime: number, emptyStepTime: number, 
*   branchTime: number}} 
* @private 
*/ 
+2

これらは[JSDoc]( http://en.wikipedia.org/wiki/JSDoc)タグ、この場合は[Google Closure compiler](https://developers.google.com/closure/compiler/docs/js-for-compiler)のタ​​グ彼らは実際に機能的な目的を果たすことができます(私はあなたの貼り付けられた例で '@ typedef'と' @ private'タグのようにコンパイラがそれらを実際に強制すると思います)。 – Ricket

0

はオルテリウスと呼ばれるアプリケーションを試してみてください。それは、ドキュメントを生成するために、ある種のjavadoc構文を使用します。 ortelius.marten.dk

関連する問題