javascript-Javascript中API文档书写的问题

问题描述

Javascript中API文档书写的问题

今天看了下百度地图的Javascript文档,在map类中,有个API是这样的

 getViewport(view: Array<Point>[, viewportOptions: ViewportOptions])

这个getViewport里面的参数这么整是什么意思,特别是[,这里为何要加逗号,
viewportOptions: ViewportOptions]这一部分又是什么意思,是要传viewportOptions类型的参数还是怎样

解决方案

[, viewportOptions: ViewportOptions],使用[]表示是可选参数的吧。

解决方案二:

表示缺省,可以传递也可以不传递,和 毕小宝 说的一样。参数后面的:是百度api的特别说明,参数什么类型的,js语法不支持这样申明参数

时间: 2025-01-27 10:05:18

javascript-Javascript中API文档书写的问题的相关文章

android中ActionSupport这个类是干嘛的,api文档可以查到吗

问题描述 android中ActionSupport这个类是干嘛的,api文档可以查到吗 android中ActionSupport这个类是干嘛的,api文档可以查到吗 安卓api开发文档都提供哪些类,哪些方法,哪些设计模式的讲解啊 解决方案 http://www.boyunjian.com/javadoc/org.apache.struts.xwork/xwork-core/2.3.16.3/_/com/opensymphony/xwork2/ActionSupport.html在线文档自己查

有关用 Swift 访问后端服务器的 API 文档中

本文讲的是有关用 Swift 访问后端服务器的 API 文档中, 我最近开始开发一个全新的项目,并且我正尝试一些新的设计模式,因为我开始投身于 Swift 3.我正使用的一个模式是"请求和响应模型".这个"酷炫"的名字是我为记录这个后台 API 文档中的 Struct (结构体).让我们来看一个例子: import Alamofire protocol Request { var path : String { get } var method : Method {

api文档-ConsoleReader为什么在API文档中找不到?

问题描述 ConsoleReader为什么在API文档中找不到? 为什么我在API文档中找不到ConsoleReader这个类 不是在util包中吗? util包索引也找不到,是不是我的文档有问题?

Spring Boot中使用Swagger2构建强大的RESTful API文档

由于Spring Boot能够快速开发.便捷部署等特性,相信有很大一部分Spring Boot的用户会用来构建RESTful API.而我们构建RESTful API的目的通常都是由于多终端的原因,这些终端会共用很多底层业务逻辑,因此我们会抽象出这样一层来同时服务于多个移动端或者Web前端. 这样一来,我们的RESTful API就有可能要面对多个开发人员或多个开发团队:IOS开发.Android开发或是Web开发等.为了减少与其他团队平时开发期间的频繁沟通成本,传统做法我们会创建一份RESTf

javaScript 读取和设置文档元素的样式属性_javascript技巧

首先我们先说一下样式表属性 1. 内联样式即元素style属性里面设置的,级别最高 2. 页面样式表定义即页面<style></style>里面定义的,级别次之 3.外部链接样式表文件 JavaScript获取和设置文档元素的css属性: 1.获取元素Style属性里面设置的样式属性, document.getElementById(id).style.height; 有,则返回属性值:没有则返回空 IE和火狐皆然,只是有的属性值返回可能不一样,比如像颜色火狐返回rgb,而IE是返

api文档-android sdk源代码中有的.java文件没有对应的.class文件

问题描述 android sdk源代码中有的.java文件没有对应的.class文件 例如WebViewProvider这个类,在platforms/android-19/android.jar中没有相应的.class文件,而在sources/android-19/android/webkit/中是有这一个java文件的. 而且在API文档中只能找到.class文件的帮助文档.应用在运行时如果用到这个类,是如何找到它的呢?

javascript获取元素离文档各边距离的方法_javascript技巧

本文实例讲述了javascript获取元素离文档各边距离的方法.分享给大家供大家参考.具体实现方法如下: 复制代码 代码如下: function getDistance(obj) {   if (!obj instanceof jQuery) {       obj = $(obj);   }   var distance = {};   distance.top = (obj.offset().top - $(document).scrollTop());   distance.bottom

YUIDoc example代码高亮错误、生成API文档目录不按源文件注释顺序

1.如果发现yuidoc命令用不了,那就重装nodejs吧    昨天不知道是清扫电脑的原因,yuidoc命令用不了(命令不存在),也没有找到好的解决方法,怒重装YUIDoc也不行.最后想了想,怒重装了nodejs,再装回YUIDoc,发现又可以了,原因还没找到. 2.YUIDoc的theme中的simple模板,sidebar.handlebar有写错.    里面属性遍历的properties被写成了events 3.YUIDoc example代码高亮错误的解决方法   使用过YUIDoc

研究 Java 中 XML 文档模型的特性和性能

xml|性能 Java 中的 XML: 文档模型,第一部分:性能 研究 Java 中 XML 文档模型的特性和性能 文档选项 将此页作为电子邮件发送 最新推荐 Java 应用开发源动力 - 下载免费软件,快速启动开发 级别: 初级 Dennis M. Sosnoski, 总裁, Sosnoski Software Solutions, Inc. 2001 年 9 月 01 日 在本文中,Java 顾问 Dennis Sosnoski 比较几个 Java 文档模型的性能和功能.当选择模型时,无法做