2010-11-03 25 views
13

¿Existe documentación para qué subconjunto JSDoc, superconjunto o mezcla de los dos soportes IntelliJ admite? Mi motivación para el uso jsdoc es doble:Compatibilidad con JSDoc en IntelliJ IDEA

  1. Para los desarrolladores: por lo IntelliJ puede proporcionar un mejor código de finalización, la comprobación de código, comprobación de errores, etc.
  2. Para una mayor eficiencia en tiempo de ejecución: el uso de la Closure compiler.

Para # 1 anterior, es importante para mí utilizar marcado jsdoc que se apoya en IntelliJ, y hasta ahora calcular esto sobre todo ha sido un proceso de ensayo y error.

Respuesta

6

Ha sido un poco de prueba y error, pero finalmente he podido obtener buenos resultados con él. Tuve un problema especial con obtener herencia para Backbone similar OO para que funcione correctamente. Lo que terminé haciendo fue cosas como esta:

/** 
* @class App.Views.ProductView 
* @extends App.Views.TemplateView 
**/ 
App.Views.ProductView = App.Views.TemplateView.extend(
    /** @lends App.Views.ProductView **/ 
    { 
     /** 
     * @param {string} str 
     * @return string[] 
     **/ 
     method: function (str) { 
      return [str, str]; 
    } 
    }; 

Sin duda hay que ayudar a un montón de forma manual cuando se trata de la herencia.

Por lo que yo puedo decir, las discrepancias fueron: que tienen para proporcionar un nombre a @class, de lo contrario se confunde. @name parece no funcionar realmente bien. El resto es decente, algunas de las etiquetas no se usan (@event, etc ...).