JavaScript中代碼註釋的正確方式是什麼

Javascript中代碼註釋的正確方式是什麼？與Java中的語法相同嗎？和工具居然會拿這些評論的優勢：JavaScript中代碼註釋的正確方式是什麼

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

我找到了新的ReSharper的6（我寫的JS在2010年的VisualStudio）提供了相同的意見，如C＃，但僅限於功能體，像/// <param name="overlayElement"></param> 。 JS代碼評論沒有被ReSharper強調。

什麼是最好的方式去...？

來源

2011-07-25 Horst Walter

使用//比/* */更好，因爲那樣你可以使用後者來取出包含其他評論的整個塊。但是，如果您想使用自動文檔生成工具，則必須使用類似於javaDoc樣式的註釋。

這是將與銳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 
*/

來源

2011-07-25 12:23:37

所以它和javadoc很相似，很高興知道。感謝所有幫助過的人。 –

好的做法是使用//代替/* */

的原因是因爲如果在評論的任何部分都*/（假設你不打算結束還），這將結束註釋。即使*/位於字符串中，也會發生這種情況。即"*/" < ---這將結束評論，並可能會給你一個語法錯誤。

note //以換行符結束，因此您需要//作爲每行註釋。

來源

2011-07-25 12:14:31

注：CTRL-K，Ctrl-C鍵和Ctrl-K鍵，Ctrl-U是用於註釋和取消註釋代碼方便快捷方式。 –

我不同意並且更喜歡'/ * * /'always .. minifiers ..以及它總是派上用場的許多原因。 – TheBlackBenzKid

一個很好的例子是基於Java的評論，它也與JSDoc一起使用。你可以在這裏找到示例：http://code.google.com/p/jsdoc-toolkit/wiki/FAQ

要添加簡單的在線人作爲評論，//仍然是評論你的代碼的好方法。但爲了生成文檔，我會使用JSDoc語法。我過去曾經使用過它，效果很好。

來源

2011-07-25 12:23:08 margusholland

JavaScript中代碼註釋的正確方式是什麼

回答

相關問題