zoukankan      html  css  js  c++  java
  • API文档生成 -JS

    前言

    上一篇写了关于C#中类和方法的帮助文档生成,本篇介绍JS的文档生成。

    这是JS文档生成的效果图:

    一、需要用到的工具:

    1、jdk,因为js的这个文档生成工具是用JAVA写的,所以需要有JAVA环境,JDK的安装和配置简单介绍如下:

    下载链接在文末!

    JAVA系统环境的配置:

    配置环境变量:右击“我的电脑”-->"高级"-->"环境变量"

    1)、在系统变量里新建JAVA_HOME变量,变量值为:C:Program FilesJavajdk1.6.0_14(根据自己的安装路径填写)

    2)、新建classpath变量,变量值为:.;%JAVA_HOME%lib;%JAVA_HOME%lib ools.jar

    3)、在path变量(已存在不用新建)添加变量值:%JAVA_HOME%in;%JAVA_HOME%jrein(注意变量值之间用“;”隔开)

    4)、“开始”-->“运行”-->输入“javac”-->"Enter",如果能正常打印用法说明配置成功!

    2、jsdoc_toolkit

    使用到的工具叫jsdoc_toolkit,下载链接在文末,下载后解压即可使用。

    3、js文档生成

    java -jar jsrun.jar app/run.js -a -e=GB18030 -t=templates/jsdoc src/*.js 

    通过命令行执行上面语句,也可以在jsdoc_toolkit解压目录下将上述语句保存批处理文件,这样执行更方便。

    上述语句参数说明如下:

    -a 表示全部的方法
    -e 表示对应的文件的编码根式 这里对应的是GB18030 默认的是utf-8
    -t  表示生产doc的文档样式模板
    这里的src/*.js表示在test目录下的全部javascript文件
    执行完毕后将文档结果默认输出到/out/jsdoc目录下。

    二、JS注释规范

    注释以/**开头,以*/结束,关键字以@开头

     三、工具包

    链接:https://pan.baidu.com/s/1c5NnhhHAqdp40pOR5ZY84g
    提取码:bkrm

  • 相关阅读:
    SharePoint Framework (SPFx) 开发入门教程
    SharePoint 2013 Designer 入门教程
    SharePoint 2013 开发教程
    SharePoint 2013 入门教程
    SharePoint Online 部署SPFx Web部件
    SharePoint Online SPFx Web部件绑定数据
    SharePoint Online 创建SPFx客户端Web部件
    SharePoint Online 配置框架(SPFx)开发环境
    SharePoint Online 创建应用程序目录
    SharePoint Online 启用 IRM
  • 原文地址:https://www.cnblogs.com/Alenliu/p/15141031.html
Copyright © 2011-2022 走看看