doxmod

Generate your documentation from svn module

Usage no npm install needed!

<script type="module">
  import doxmod from 'https://cdn.skypack.dev/doxmod';
</script>

README

简介

根据dox获取模块中符合JSDoc的注释，然后生成对应的API文档。

安装

安装doxmod为全局工具

使用说明

使用doxmod命令，需要制定一个package.json文件为配置文件，配置文件里面添加输出文档的output目录，以及product产品，包含模块对象， 每个模块有名称、描述、链接、svn地址、svn用户名和密码，以及需要分析JS注释的目录和存放svn checkout的目录。其他待定 可在package.json同目录下存放templates目录，自定义文档模版和静态资源。

JS注释规范说明

按照JSDoc的要求书写注释，有个特殊的地方，每个文件开始都要有一段注释，注释内容为author和description。