JavaScript'teki doğru kod yorumu yolu nedir?

Question

Javascript'teki kod yorumlarının doğru yolu nedir? Java ile aynı sözdizimi nedir? Ve hangi araçlar aslında bu yorumların yararlanmak olacaktır:

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

Yeni Resharper 6 (Ben 2010 VisualStudio JS yazmak) C# ile aynı yorumlar sunuyor, ama sadece fonksiyonları bünyesinde, /// <param name="overlayElement"></param> gibi bir şey buldum. JS kod yorumları ReSharper tarafından vurgulanmamıştır.

Gitmenin en iyi yolu nedir?

Answer 1

/* */ daha iyidir. Bununla birlikte, otomatik bir dokümantasyon oluşturma aracı kullanmak istiyorsanız, javaDoc stiline benzer yorumlar kullanmalısınız.

Bu

bir YUI DOC ile çalışacak, örneğin (en iyisi) 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 
*/ 

Answer 2

iyi bir uygulama, bu yorumunu sona ereceğini yerine /* */

yorumun herhangi bir bölümünde */ varsa (henüz sona niyetinde değilim varsayarak) çünkü bunun sebebi değildir // kullanmaktır. Bu, */ bir dizede olsa bile olur. "*/" < --- bu, yorumu sonlandırır ve size bir sözdizimi hatası verir.

not // bir satır sonuyla sona erer, böylece her satır için // gerekir.

Answer 3

İyi bir örnek, JSDoc ile de kullanılan Java tabanlı yorumlamadır. Örnekleri şu adreste bulabilirsiniz: http://code.google.com/p/jsdoc-toolkit/wiki/FAQ

Yorumlara basit onlinler eklemek için //, kodunuzu yorumlamak için hala iyi bir yoldur. Ancak dokümantasyon oluşturmak için JSDoc sözdizimi ile giderdim. Geçmişte kullandım ve gayet iyi çalışıyor. o zaman diğer yorumların yer bütün bir blok almaya ikincisi kullanabilirsiniz çünkü // kullanarak