jsdoc注释规范工具(使用 JSDoc 3 自动生成 JavaScript API 文档)

安装和使用规范见:http://moodpo.com/archives/jsdoc3-tutorial.html

实例:

/**
 * 模块调用方法
 *
 *
 * @param  {string}   moduleName 模块名称
 * @param  {Function} callback   模块加载完成的回调,回调函数中会返回模块对象,方便内部调用
 * @param  {Boolean}  isQueue    是否加入队列:在队列中的文件逐个加载(非异步)
 * @param  {date}     timeout    延时加载的时间以毫秒为单位
 *
 * @return {[type]}              不管模块是否加载成功,都会返回跟对象,便于链式调用 ;
 *                               链式调用与模块的加载情况是异步的,没有依赖关系,
                                 所以在链式调用中不能确保能够调用到模块中的方法
 * @example

            xue.use(‘pages‘, function(module){
                // 根据模块名称进行调用
                xue.pages.config({
                    pages : 22,
                    current : 1
                }).go(3);

                // 根据返回的对象进行调用
                module(‘page2‘).config({
                    pages: 10,
                    current: 3
                });
            }, true, 1000).test();
 */
时间: 2025-01-14 04:21:15

jsdoc注释规范工具(使用 JSDoc 3 自动生成 JavaScript API 文档)的相关文章

Spring Boot 整合 swagger2 自动生成 RESTFul API 文档

1)首先编辑pom.xml添加依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId>

javadoc 工具生成开发API文档

=====================先来一点成就感===================== 1 package com.springMybatis.dao; 2 3 import com.springMybatis.model.*; 4 5 6 /** 7 * AuthorizationDao 定义Authorization接口 8 * @author g.qu 9 * @see java.lang 10 */ 11 public interface AuthorizationDao{

MFC:“Debug Assertion Failed!” ——自动生成的单文档程序项目编译运行就有错误

今天照着孙鑫老师的VC++教程学习文件的操作,VS2010,单文档应用程序,项目文件命名为File,也就有了自动生成的CFileDoc.CFileView等类,一进去就编译运行(就是最初自动生成的项目),编译通过,可运行时直接弹出错误框,有点小懵,,,啥都没做就给我看这个: 图一   错误提示框 后来搜索一查,网上好多类似的错误以及解决方案,几乎都试了个遍,有: 方法(1)-重新生成解决方案,或者将项目文件目录下Debug文件夹删了,重新生成Release版: 方法(2)-可以先声明一个临时的C

SpringBoot2.0系列教程(六)Springboot框架添加Swagger2来在线自动生成接口的文档+测试功能

Hello大家好,本章我们添加Swagger2来在线自动生成接口的文档+测试功能.有问题可以联系我[email protected].另求各路大神指点,感谢 一:什么是Swagger Swagger是一款通过我们添加的注解来对方法进行说明,来自动生成项目的在线api接口文档的web服务. 二:添加Swagger2依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swag

zeal工具的安装与使用(离线api文档浏览器)

本来想下载一个dash来用一下,结果它只有mac版本,没有windows版,遂使用zeal zeal官网:https://zealdocs.org/ 文档地址:http://kapeli.com/docset_links 1.下载安装zeal 下载下来,进行安装,点击下一步下一步就可以了! 安装完成!但是没有文档! 2.下载文档解压放置于zeal的docsets文件下 重新打开zeal mysql的api文档已经被加载进来,可以使用搜索了!--------------------- 作者:安善良

API文档注释 Javadoc

阅读API文档 JDK包结构 JDK包是由sun开发的一组已经实现的类库,.JDK根据提供的功能不同,将类库划分为若干个包,比如用于操作输入输出的  java.io包,java程序语言设计基础类的   java.lang包, 默认导入的提供各种数学运算的 java.math包,基于网络应用的 java.net包, 一些共用程序类所在的 java.util包 文档注释规范 javadoc 生成文档 1. 文档注释的意义及规范 通过注释提高Java源程序代码的可读性:使得Java程序条理清晰,易于区

Web API文档生成工具apidoc

apidoc可以根据代码注释生成web api文档,支持大部分主流语言java javascript php coffeescript erlang perl python ruby go...,相对而言,web接口的注释维护起来更加方便,不需要额外再维护一份文档. apidoc从注释生成静态html网页文档,不仅支持项目版本号,还支持api版本号. 安装 主页: http://apidocjs.comgithub: https://github.com/apidoc/apidoc可以使用npm

DRF中自动生成API文档

自动生成api文档(不管是函数视图还是类视图都能显示) 1.安装rest_framework_swagger库 pip install django-rest-swagger 2.在项目下的 urls.py 中加入如下: from rest_framework_swagger.views import get_swagger_view schema_view = get_swagger_view(title='API文档') urlpatterns += [ path(r'docs/', sch

利用Vistual Studio自带的xsd.exe工具,根据XML自动生成XSD

利用Vistual Studio自带的xsd.exe工具,根据XML自动生成XSD 1, 命令提示符-->找到vs自带的xsd.exe工具所在的文件夹 例如: C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0A\Bin 注意:win7操作系统“命令提示符”要以管理员身份运行 2,将Xml文件拷贝到xsd.exe工具所在的文件夹,生成的xsd文件也将在这个文件夹中 3,在命令提示符中输入 xsd.exe test.xml, 多个xml文件以空格隔