Skip to content

故障

目前记录生成文档时产生的各种问题,仅仅是一个日志性质的记录文档。

typedoc 方案不可行

首先要通过类型检查才行。如果目标 js 文件没有普遍通过类型检查,是不能用 typedoc 生成文件的。

如果跳过类型检查,那么几乎没有文档生成出来。

rmmv 的源码普遍无法通过严格的类型检查。无法继续实现文档生成。

严格 jsdoc 格式太少

jsdoc-to-markdown 方案,理论上可行,但是实际上发现大多数目标文件,没有足够数量的,严格 jsdoc 格式的注释,所以无法生成完整覆盖源码的文档。

解决方案: 新的文档生成脚本会为没有 JSDoc 注释的文件生成说明文档,并提供 JSDoc 格式示例。

该方案基本能够走得通

目前能够实现文档生成了。

贡献者

The avatar of contributor named as ruan-cat ruan-cat

页面历史

最近更新