builddocs:将getdocs风格的文档注释转换为HTML文档

时间:2024-05-28 09:54:01
【文件属性】:

文件名称:builddocs:将getdocs风格的文档注释转换为HTML文档

文件大小:19KB

文件格式:ZIP

更新时间:2024-05-28 09:54:01

JavaScript

builddocs 这是一个实用程序,可将使用 -style doc注释记录的代码转换为HTML。 它导出以下值: build : (config: Object, items: ?Object) → string 为给定的文件集构建文档。 配置对象可能具有以下字段: name : string此模块的名称。 filename : string如果未提供items ,则应指向要从中提取文档的主文件名。 main : ?string主模板的路径,该模板应该是带有@itemName占位符的Markdown文件,应在其中插入源文件中已生成项目的文档。 当项目占位符集与记录的项目集不匹配时,builddocs将抱怨。 如果未给出,则将按照找到它们的顺序输出它们。 mainText : ?string主模板作为字符串。 anchorPrefix : ?string可用于替代生成HT


【文件预览】:
builddocs-master
----.gitignore(22B)
----templates()
--------type.html(3KB)
--------class.html(1KB)
--------enum.html(510B)
--------markdown()
--------typeparams.html(248B)
--------fntype.html(312B)
--------typealias.html(524B)
--------define.html(1KB)
--------typeParens.html(182B)
--------typeparam.html(242B)
--------reexport.html(273B)
--------item.html(324B)
--------param.html(355B)
----package.json(760B)
----src()
--------builtins.js(6KB)
--------browser.js(9KB)
--------builddocs.js(7KB)
----bin()
--------builddocs.js(984B)
----LICENSE(1KB)
----README.md(3KB)
----.npmignore(22B)

网友评论