使用YUIDoc创建js文档

标签：selected   contain   标识   对象   环境   data   get   ado   另一个   

什么是YUIDoc？

YUIDoc会根据你写的代码注释生成API文档。

YUIDoc是个NodeJS应用，能将你的JS代码中的注释生成HTML格式的API文档。事实上，不仅是JS，任何支持块注释的语言都能使用。

安装

要安装YUIDoc，首先要安装好NodeJS，然后使用 npm -g install yuidocjs 即可安装YUIDoc。

使用

1. 在相应的目录下输入 yuidoc . ，会在当前目录生成 out文件，里面生成注释文档
2. 在相应的目录下输入 yuidoc . –server <port>，会使用nodejs环境生成对应的网站

基本语法

详见YUIDoc官方文档

YUIDoc从源文件的多行注释中抽取到文档内容。当然，你会有些注释不想成为文档的一部分，让YUIDoc知道你的注释是非常重要的，必须以两个*开头。如下：

/**
 * YUIDoc 会认出这个
 */

/*
 * YUIDoc 不会认这个
 */

主标签

开始讲主标签之前，必须明确一点，每个注释块中能切仅有一个主标签。描述了当前代码块的作用。

@module

@module标签描述了一组关联的类（JS中并不包含类，YUIDoc把构造器归纳成类）。如果我们用YUIDoc生成UDTWO的文档，那UDTWO对象就是个module，因为他同时管理Model、Collection、View和其他类。标签后面跟着写@module的名称：

/**
 * 此处以声明一个名为UDTWO的模块
 * @module UDTWO
 */

注意：module需与method分开写，否则method无法被识别。

常用的一些标签：

 代码实例：

/**
* 常用方法
* @module 常用方法
*/

/** 
* 数组方法
* @class 数组方法
*/


/**
 * 
 * @method arr_splice
 * @name 切割数组前n个元素
 * @param {Array} arr:需要切割的数组
 * @param {Number} n：切割前n个元素
 * @return {Array} arr:返回一个数组
 */
function arr_splice(arr,n){//arr:数组,n:切割前n个
    if(arr && arr.length>n){
        let new_arr=arr.splice(n);
        return new_arr;
    }else{
        return arr;
    }
};

export{
    arr_splice,//切割数组前n个元素
}

 运行 yuidoc .，输出一个文档项目

使用YUIDoc创建js文档

标签：selected   contain   标识   对象   环境   data   get   ado   另一个   

原文地址：https://www.cnblogs.com/linfblog/p/12150743.html