2011-07-25 20 views
11

Javascriptのコードコメントの正しい方法は何ですか--Javaと同じ構文ですか?そして、そのツールは、実際にこれらのコメントの利点を取る:JavaScriptのコードコメントの正しい方法は何ですか

/* 
    * Add an element to the group 
    * @param {Object} overlayElement 
    * @param {Object} [element2] optional element 
    */ 

は、私は新しいReSharperの6(私は2010年のVisualStudioでJSを書く)C#で同じコメントを提供していますが、唯一の機能本体内、/// <param name="overlayElement"></param> のようなものを見つけました。 JSコードコメントは、ReSharperによって強調表示されません。

何が最善の方法ですか...?

答えて

17

//を使用すると、/* */よりも優れています。後者を使用すると、他のコメントを含むブロック全体を取り出すことができるためです。ただし、自動ドキュメント生成ツールを使用する場合は、javaDocスタイルに似たコメントを使用する必要があります。

これはYUIのDOC(最良の)で動作することになる例であるhttp://developer.yahoo.com/yui/yuidoc/#start

/** 
* This is a description 
* @namespace My.Namespace 
* @method myMethodName 
* @param {String} some string 
* @param {Object} some object 
* @return {bool} some bool 
*/ 
+0

これはjavadocとよく似ています。ありがとう、助けてくれたすべての人に。 –

7

良い練習は、あなたがコメント(あなたがまだ終了する予定がないと仮定した場合)のいずれかの部分で*/を持っている場合、それはコメントを終わるだろうので、その理由がある代わりに/* */

//を使用することです。これは文字列に*/が含まれていても発生します。すなわち"*/" < ---これでコメントが終了し、構文エラーが発生する可能性があります。

注記//は改行で終了しますので、コメント行ごとに//が必要です。

+2

注:Ctrlキーを押しながらKは、Ctrl-CとCtrl-Kは、Ctrl-Uは、コメントのための便利なショートカットやコメントを解除コードであります。 –

+0

私はそれに反対し、 '/ * * /'を常に優先します。それは常に便利です。 – TheBlackBenzKid

3

良い例は、JSDocでも使用されているJavaベースのコメント投稿です。ここでは例を見つけることができます:http://code.google.com/p/jsdoc-toolkit/wiki/FAQ

単純なオンライナーをコメントとして追加するには、//あなたのコードをコメントする良い方法です。しかし、ドキュメントを生成するためには、JSDoc構文を使用します。私は過去にそれを使用しており、それはかなりうまく動作します。

関連する問題