@hive/usage

使用方法类

Syntax

const Usage=require('@hive/usage');

var usage=new Usage(config);

Constructor

new Usage( Object config )

Parameter

• config

  • name

    名称

  • params

    @hive/params的对象, 默认为false

  • description

    使用方法描述

Properties

• name
• params
• description

Methods

• toJson

  返回json格式的使用方法

• toHTML

  返回一个使用方法的html页面