Как комментировать в jQuery

Как использовать комментарии в jQuery , автоматизировать ваши комментарии с помощью плагина и эффективно комментировать, не загружая комментарии, эффективно их использовать.

Основные комментарии jQuery

Комментарии jQuery начинаются с двойной косой черты, которая говорит интерпретатору, что следующий текст в строке не должен обрабатываться как JavaScript. Комментарии jQuery могут быть как внутри функции, так и за ее пределами.

function myFunction ( myVar, myVar2 ) { // Pay attention to spaces around // the brackets and curly brackets } 

 // some prefere it like this function myFunction() { ... } 

Многострочные комментарии jQuery

  Многострочные комментарии jQuery заключены в комбинацию прямой косой черты и звездочки, например:
  / * комментарий * / 
  Правила комментирования jQuery 
  Вот несколько советов для комментирования в jQuery: 

  Длинные комментарии должны использовать / * ... * /. 
  Однострочные комментарии всегда должны быть на отдельной строке и 

 над линией, на которую они ссылаются.  Дополнительно должен быть 

 дополнительный конец над ним.  Например: 


  var some = "stuff";

    // Мы собираемся зациклить здесь
    для (var i = 0; i <10; i ++) {}
 [/ JS]


 Источник: http://docs.jquery.com/JQuery_Core_Style_Guidelines