文件名称:doc-parser:文档解析器,doc块和注释(完全符合phpDoc和doctrine注释)
文件大小:33KB
文件格式:ZIP
更新时间:2024-06-02 23:01:04
parser documentation parse annotations documentation-tool
DocBlock和注释解析器
该库是一个JavaScript LALR(1)解析器,用于解析文档块并提取结构化语法树下的注释。
安装
npm install doc-parser --save
和简单的用法:
var DocParser = require ( 'doc-parser' ) ;
var reader = new DocParser ( ) ;
var data = reader . parse ( '/** @hello world */' ) ;
支持的语法
/**
* Some description
* @return boolean
* @return map
【文件预览】:
doc-parser-master
----.coveralls.yml(46B)
----gruntfile.js(2KB)
----src()
--------lexer.js(5KB)
--------parser.js(16KB)
--------token.js(282B)
--------index.js(708B)
----.npmignore(83B)
----.travis.yml(468B)
----LICENSE(1KB)
----test()
--------lexer.js(3KB)
--------parser.js(9KB)
--------annotations.js(4KB)
--------index.js(1KB)
----README.md(3KB)
----index.d.ts(336B)
----dist()
--------doc-parser.min.js(13KB)
--------doc-parser.js(23KB)
--------doc-parser.min.js.map(15KB)
----.jsbeautifyrc(72B)
----docs()
--------lexer.md(95B)
--------README.md(488B)
--------parser.md(1KB)
----.gitignore(38B)
----CHANGELOG.md(7KB)
----package.json(1KB)