jsdocの書き方

readme.md

##書き方 index.jsのように書く

##実行 ###npmモジュールがあるので使う npm install jsdoc ./node_modules/.bin/jsdoc index.js

github

index.js

/**
 * 音声管理
 * 
 * @constructor
 */
Index.Sound = function() {
  this.load();
}
Index.Sound.prototype = {
  /**
   * 音声ファイルのプリロード
   * 
   * @return {boolean} 真偽値を返す
   */
  load: function() {
    return true;
  },
  /**
   * 音声の再生
   * 
   * 詳しい説明があったらここに書く
   * 
   * @param {string} label 再生する音声の名前
   */
  play: function(label) {
    this.sound[label].play();
  }
};