jeudi 28 juillet 2016

EmberJS comments for JSDoc documentation

Here I have an emberJS controller as an example. How to comment it properly to generate documentation using JSDOC?

import Ember from 'ember';

/**
 * ?
 */
export default Ember.Controller.extend({
  queryParams: ['param1', 'param2'],

  /**
   * ?
   */
  param1: '',

  /**
   * ?
   */
  param2: 10,

  /**
  *
  */
  testFunc1(param) {

  },

  /** 
   *
   */
  actions: {
    /**
     * ?
     */
    testFunc2(id) {

    },

    /**
     *  ?
     */
    testFunc3() {
      /**
       * ?
       */
      function testFunc4() {
      }

    }

  }
});

I have interest to know the best practices for emberJS code documentation, so at the end I can get proper doco with complete hirerchy.




Aucun commentaire:

Enregistrer un commentaire