为TypeScript项目生成API文档
为TypeScript项目生成文档
使用typedoc为TypeScript项目生成API文档。
1. 使用typedoc生成HTML文档
需要安装 typedoc。
npm i typedoc
可以通过命令行参数指定配置信息，也可以通过加载配置文件的方式加载配置信息。
本项目中使用加载配置文件typedoc.json的方式加载信息。部分配置项信息如下：
{"entryPoints": ["index.ts"], // 设置入口点"includes": ["src/*.ts"], // 指定查找包含的文件位置"out": "docs", // 指定生成的文档的输出位置"readme": "none", // 是否在index页面展示README文件，该属性值设置为none时，index页面直接显示API文档内容"includeVersion": true, // 是否将包的版本号添加到API文档中"disableSources": false // 是否禁用反射源，默认为false，会在API文档页面出现类似 Defined in src/ArrayUtils.ts:15 的字样，如果不想在页面上显示API对应的文件源信息，可以将此属性值设置为true
}
上述配置文件中，entryPoints指定入口点，includes指定生成的文档应包含哪些文件，out选项指定文档的输出位置。其他配置项信息请自行查阅。
TypeDoc Options：http://typedoc.org/guides/options/
在项目的package.json的scripts项中增加如下命令配置：
"doc": "typedoc --options ./typedoc.json",
配置完成后，命令行执行npm run doc，命令成功执行后即可在配置的目录下生成HTML文档。
2. 使用typedoc插件typedoc-plugin-markdown生成Markdown文档
该种方式是在第一种方式的基础上进行的。在安装typedoc后再安装此插件。
npm i typedoc-plugin-markdown
该种方式的用法和第一种方法使用TypeDoc的用法一样。只是将TypeScript API文档呈现为Markdown。
插件使用命令选项除了相关的TypeDoc选项外，还可以使用其他的选项。
更多介绍请查看：typedoc-plugin-markdown npmjs
相关文章：
DropBox免费扩容到10G了
好久没有写博客了,郑重推荐下Dropbox这款同步软件,很多人有多台电脑,比如公司和家里一些文档需要同步更新,用U盘拷贝来拷贝去,不胜其烦.自然而然就想到用同步软件,而这方面DropBox从速度来说,当然是首屈一指的. 先说明DropBox的优点: 使用简单,去官网http://www.dropbox.com下…
子网划分实例与讲解
子网划分 分为两种：◆ 给定网络地址，划分子网。◆不给定网络地址，根据主机数量，自由确定网络地址，进而划分子网。【实例1】给定网络地址，划分子网。我们单位有计算机100台左右，原来都是在192.16…
使用Docsify搭建Markdown文件服务器
使用docsify快速生成文档网站1. 概述2. 安装 docsify-cli 工具3. 初始化项目4. 本地预览5. 多页文档6. 定制导航栏6.1 在index.html中添加导航栏6.2 添加导航栏配置文件6.3 下拉导航栏7. 封面设置7.1 设置封面参数7.2 自定义封面背景7.3 将封面设置为首页配置项elrepomaxLevell…
DirectX903D 颜色
颜色 颜色表示 颜色用RGB三元组表示。为红色（red）绿色（Green）蓝色（Blue）。 RGB数据可用两种不同的结构来保存。 1 D3DCOLOR结构 与DWORD类型完全相同。共有32位。各位被 分成四个8位项（sectio…
JAVA SHA1 加密 对应 c# SHA1 加密
java: 1 public static String SHA1(String decript) {2 try {3 MessageDigest digest MessageDigest.getInstance("SHA-1");4 digest.update(decript.getBytes("UTF-8"));5 byte[] messageDigest dige…
VLAN设置错误，导致部分用户无法上网
一、事由： 单位的思科3560交换机安装到位，加班到夜里12点，测试了一下，怎么有些用户PING不到了呢？难道集体关机了吗？太累了，准备明天处理。二、问题： 第二天早上࿰…
JS通过正则限制 input 输入框只能输入整数、小数(金额或者现金)
第一： 限制只能是整数 [js] view plaincopy <input type "text" name "number" id number οnkeyup "if(! /^d$/.test(this.value)){alert(只能整数);this.value;}" /> 如果不是整数就直接alert 第二： 限制是两位…
npm包开发测试与发布
NPM 包开发测试与发布NPM 包开发测试与发布引言1. 开发步骤1.1. 项目创建1.2. 工具类功能实现1.3. ts文件编译2. npm包本地测试2.1. 将npm包文件引入项目2.2. npm包功能测试3. 发布4. 注意事项我的NPM包NPM 包开发测试与发布 引言 在项目开发过程中，有时会遇到在多…
Jquery php 点击td变成input，修改后失去焦点发送数据
html部分 <Td><?php echo $row[bigclassid]?></Td> <td height"25" width"241" class"bigclassname"><?php echo $row[bigclassname]?></a></td> Js部分 <script> /**//* * 说明࿱…
美元加息怎么“剪羊毛”
我国为什么把美元储备看的如此重要? 我国需要一定的美元储备，不敢把美元随便花出去!1998年亚洲金融危机，东南亚国家为什么抵抗不过对冲基金，就是因为他们手里的美元储备太少，如果你手里美元多，就可以放出美元…
浅谈企业IT应用的访问方式之：乱想
近来手上的几大块事情，算是大头朝下了。后面可能更多是跟公司的最终用户打交道，一套完整的应用服务体系，不光只是服务器平台的搭建。更重要的是如何让用户觉得确实给他们带来了帮助。 在非洲的一段经历让我们严重认识到一点，其…
java中的基本用法
java中的基本用法 关键字：专门用途的字符串 所有java关键字都是小写英文标识符 java常量 java变量 ■ 作用域：起作用的区域■ 使用前必须先声明，在赋值。使用变量名访问这块区域java程序执行过程 java变量的分类 ■ 局部变量■ 成员变量■…
JavaScript中双叹号(!!)和单叹号(!)
转自：JavaScript中双叹号(!!)作用 经常看到这样的例子： var a； var b!!a; a默认是undefined。!a是true，!!a则是false，所以b的值是false，而不再是undefined，也非其它值，主要是为后续判…
git 初次push
1、本地仓库与远程仓库第一次同步时，一直同步不上 最后 git status ,发现有两个文件没提交 提交后再push即可 2、如果不行，再看一下其他情况 转载于:https://www.cnblogs.com/sanhao/p/10681919.html
简单是可靠的先决条件
2010年4月编程语言排名，C语言重回第1宝座，不禁令人感叹C语言的生命力。 记得有人在几年前发表了一篇C语言已经死了，5个需要忘却它的理由，其后有人发表驳“C语言已经死了”，又有人发表也驳"驳C语言已经死了" …
帮朋友招聘赴北京微软ASP.NET开发工程师
职位要求：1. 3年以上ASP.NET开发经验。2. 有过大型门户网站开发经验。3. 精通ASP.NET WEB开发、Ajax技术，有良好的代码编写习惯。4. 能够熟练运用MVC框架。有意向的朋友可以将简历发到我邮箱：fanmenglifemicrosoftservices.com.cn转载于:http…
xx.xib: error: Illegal Configuration: Safe Area Layout Guide before iOS 9.0报错问题解决
之前是用xcode8.3.3创建的工程最近升级到Xcode9.0 遇见了这个问题 在Xcode 9.0以上 新建xib文件会报错 xx.xib: error: Illegal Configuration: Safe Area Layout Guide before iOS 9.0 是因为在iOS 11上安全距离的变化引起的解决办法如下图：（以UITableV…
LuoguP2617 Dynamic Rankings (动态主席树学习理解)
题目地址 题目链接 题解 动态主席树的板子题。动态主席树其实和静态的有很大差别，虽然同样是n个根，但是节点并不能共用，每个根节点表示bit上的一段区间。 所以其实是个树套树的东西来着，外层是bit，内层是主席树。 然后…
Flash气泡回弹效果
好久没有碰过Flash了，今天温习一下AS3.0，做了一个回弹效果，气泡回弹本想着怎么可以定义气泡的不同颜色，这样可以做出更绚丽的效果，或者更进步一，气泡和气泡直接回弹，想了老半天没有想出来&#…
数据库连接的代码
数据库连接前的准备 数据库连接的jar包 数据库连接的java代码： package com.it.util;import java.sql.Connection; import java.sql.DriverManager; import java.sql.SQLException;public class Dbutil {private String jdbcName"com.mysql.jdbc.Driver"…
windows建立PPPoE服务器
windows建立PPPoE服务器1.下载RASPPPOE（0.99版）2.安装RASPPPOE协议本地连接-->属性-->常规-->安装-->协议-->添加-->从磁盘安装-->浏览-->“找到自己RASPPOE所在的目录下的那个winpppoe.inf”-->打开-->继续……………即可…
使用 Azure CLI 管理 Azure 虚拟网络和 Linux 虚拟机
Azure 虚拟机使用 Azure 网络进行内部和外部网络通信。 本教程将指导读者部署两个虚拟机，并为这些 VM 配置 Azure 网络。 本教程中的示例假设 VM 将要托管包含数据库后端的 Web 应用程序，但本教程并不介绍如何部署应用程序。 本教程介绍如何执行下列操作…
面向对象的内存分析
注意：成员属性是有默认的初始值。数据类型 默认的初始值int 0float 0.0fdouble 0.0char String null引用数据类型 …
ModuleNotFoundError: No module named ‘qcloud_cos‘
是腾讯云提供的一个Python SDK，用于与腾讯云对象存储（COS）服务进行交互。使用pip安装qcloud_cos报以下错误。这个错误表示Python无法找到名为。
java常见的四个运行时期的异常
空指针异常 数组越界异常 类型转换异常 无效参数异常
ASP.NET 4.0: 请求验证模式变化导致ValidateRequest=false失效
ASP.NET请求验证功能可以给我提供应用程序的安全保证，避免站点受到XSS的攻击。但是在一些情况下，我们需要禁用这个功能，比如我们需要使用HtmlEditor来让用户输入一些HTML文本，这时候ASP.NET 2.0允许我们可以通过在web.config设置v…
[CTO札记]从技术走向商业的3级转变
思想原创：老刀。
[Ubuntu] 安装/卸载 声卡驱动
卸载sudo apt-get --purge remove linux-sound-base alsa-base alsa-utils安装sudo apt-get install linux-sound-base alsa-base alsa-utils 可以这样来处理声卡驱动突然出现异常的情况。 转载于:https://www.cnblogs.com/davidhhuan/archive/2010/04/21/1716941.html
java异常类 Object类
1.Object类 Object类是所有类的父类,是最顶层的父类.当一个类没有直接继承其它父类时,这个类的直接父类就是Object类.class Person {...}等价于class Person extends Object {...} Object 里的equals方法: boolean equals(Object obj):判断当前对象与obj对象的地址是否一样,…
『TensorFlow』卷积层、池化层详解
一、前向计算和反向传播数学过程讲解 这里讲解的是平均池化层，最大池化层见本文第三小节 二、测试代码 数据和上面完全一致，自行打印验证即可。 1、前向传播 import tensorflow as tf import numpy as np# 输入张量为33的二维矩阵 M np.array([[[1], [-…