YUIDoc Javascript Dcumentation Tool

5449 ワード

ある時、生活はあなたと正しいです.あなたがやりたいことがやればやるほどできなくなりますが、やりたくないことはいつもあなたを見つけます.
                                                                                                                         --- chenhailong
 
じゃ、本題に入ります.
公式サイト:
http://yui.github.com/yuidoc/
 
公式サイトでインストールの過程を与えました.
 
 
  • Download and install  Node.js
  • Run  npm -g install yuidocjs.
  • Run  yuidoc . at the top of your JS source tree.
  • 私も通訳です.
    1.Node.jsをダウンロードする:
    http://nodejs.org/#download
    2.実行:
     npm -g install yuidocjs( yuidocjs)3.「yuidoc.」を実行する
    YUIDocの文法を紹介します.
    モード
    /**
    Provides the base Widget class...
    
    @module widget
    **/
    メールの方式
    /**
    Provides more functionality for the widget module..
    
    @module widget
    @submodule widget-foo
    @main widget
    **/
    クラスの方式
     
    /**
    A utility that brokers HTTP requests...
    
    @class IO 
    @constructor
    **/
    function IO (config) {
     
    methodの方式
     
    /**
    Returns this model's attributes as...
    
    @method toJSON
    @return {Object} Copy of ...
    **/
    toJSON: function () {
     
    イベントの方式
     
    /**
    Fired when an error occurs...
    
    @event error 
    @param {String} msg A description of...
    **/
    var EVT_ERROR = 'error',
     
    propertyの方式
     
    /**
    Template for this view's container...
    
    @property containerTemplate 
    @type String
    @default "<div/>"
    **/
    containerTemplate: '<div/>',
     
    atributeの方式
     
     
    /**
    * Indicates whether this Widget
    * has been rendered...
    *
    * @attribute rendered
    * @readOnly
    * @default false
    * @type boolean
    */
    ATTRS[RENDERED] = {
     
    上はいつもの方式と方法です.
     
    具体的には参考になる  http://yui.github.com/yuidoc/syntax/index.html
     
    次の例を示します.
     
    1.yuidocの取り付け
     
    npm config set proxy=http://me.proxy:8080
     
    npm-g install yuidocjs
    2.ユビキタスはデフォルトではシステムセットのパスです.もしないなら、手作業で追加します.
    3.cdからプロジェクトに指定されたプロジェクトのプロジェクトの下に
    4.yuidoc.jsonを追加する
     
     
     
    {
        "name": "Documenting JavaScript with YUIDoc",
        "description": "A tutorial about YUIDoc, for Nettuts+",
        "version": "1.0.0",
        "url": "http://net.tutsplus.com",
        "options": {
            "linkNatives": "true",
            "outdir": "docs",
            "paths": "."
        }
    }
     
     
    5.作成した文書の会長docsで、「yuidoc.」を実行するとdocが生成されます.
     
    次はsourceを提供します.皆さんに助けてほしいです.