yuidocでアンダースコア(アンダーバー)を使うと消える件

2013-03-18T00:00:00+00:00 JavaScript

var Sample = (function() {

  /**
   * @class Sample
   * @constructor
   */
  function Sample() {};

  /**
   * @method getUser
   * @return {Object} current user by localStorage(sample_current_user)
   */
  Sample.prototype.getUser = function() {
    return localStorage.getItem("sample_current_user");
  };

  return Sample;

})();

みたいなコード及びyuidocなドキュメントアノテーション?を書いた状態でyuidocすると

おい、アンダースコアどこ行ったっていう感じになる。どうやらそういう記法なんですかね。MLにも対策が書かれてた。https://groups.google.com/forum/#!msg/yuidoc/iUyugJZxuFc/a_qxtEjlXQoJ

そういうところに当たる部分をbackticks(`の事?)で指定すれば良いって事かと。つまり@returnな部分がどうもって事だと思うので

/**
 * @method getUser
 * @return {Object} current user by localStorage(`sample_current_user`)
 */

な感じで書き換えたら

な感じになった。とりあえずハマったのでメモ

MapFragmentを使ってみた 「mocha-phantomjs+jscoverageでコードカバレッジ出力」な流れをgruntに移植する