Docco文档生成器
Docco 是一个应急用的文档生成器。使用 Literate CoffeeScript 编写。可生成 HTML 文档来显示你在代码中的注释。使用 Markdown 语法,代码通过 Pygments 语法高亮。
文档生成功能
通过复制静态代码,读取所有源文件,将它们分成注释 + 代码两个部分,用适当的语言突出显示每个文件并在 HTML 模板中将它们打印出来,来为我们配置的源文件生成文档。
document = (options = {}, callback) ->
config = configure options
fs.mkdirs config.output, ->
callback or= (error) -> throw error if error
copyAsset = (file, callback) ->
return callback() unless fs.existsSync file
fs.copy file, path.join(config.output, path.basename(file)), callback
complete = ->
copyAsset config.css, (error) ->
return callback error if error
return copyAsset config.public, callback if fs.existsSync config.public
callback()
files = config.sources.slice()
nextFile = ->
source = files.shift()
fs.readFile source, (error, buffer) ->
return callback error if error
code = buffer.toString()
sections = parse source, code, config
format source, sections, config
write source, sections, config
if files.length then nextFile() else complete()
nextFile()
更多详情请查看软件文档
评论