什么选项可用于记录您的Javascript代码？ [英] What options are available for documenting your Javascript code?

问题描述

有没有像dOxygen / Javadoc这样的东西？每个人在那里使用的功能都很好？

解决方案

Javascript文档的800磅大猩猩是 JSDoc Toolkit 及其后继 JSDoc 3 。大多数文档都是使用Javadoc样标签和 / ** 注释前缀完成的。

示例： / p>

  var MyClass = Class.create（
 / ** @lends MyClass＃* / // @lends是怎么样的文档匿名类
 {
 / ** 
 *构造函数的描述
 * @class类的描述// @class注释到任何地方，
 * / / b描述整个类
 * @constructs //这是一个构造函数
 * / 
 initialize：function（arg0，arg1）{
 // ... 
}，
 
 / **一个方法* / 
 myFunc：function（）{}，
 
 / **一个实例字段* / 
 myVar：123 
} 
）; 
 
 Object.extend（MyClass，
 / ** @lends MyClass * / 
 {
 / **一个类方法* / 
 classFunc： function（）{} 
} 
）; 
  

Is there something like dOxygen/Javadoc? What has everyone used out there that has worked well?

解决方案

The 800-pound gorilla of Javascript documentation is the JSDoc Toolkit and its successor JSDoc 3. Most of the documentation is done with Javadoc-like tags and a /** comment prefix.

Example:

var MyClass = Class.create(
  /** @lends MyClass# */              // @lends is how you document anonymous classes.
  {
    /**
     * Description of constructor.
     * @class Description of class.   // @class annotation goes anywhere and
     *                                //   describes the whole class.
     * @constructs                    // This is a constructor.
     */
    initialize: function(arg0, arg1) {
      //...
    },

    /** A method. */
    myFunc: function() {},

    /** An instance field. */
    myVar: 123
  }
);

Object.extend(MyClass,
  /** @lends MyClass */
  {
    /** A class method. */
    classFunc: function() {}
  }
);

这篇关于什么选项可用于记录您的Javascript代码？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！