Docco是一个应急用的文档生成器。使用LiterateCoffeeScript编写。可生成HTML文档来显示你在代码中的注释。使用Markdown语法,代码通过Pygments语法高亮。
文档生成功能通过复制静态代码,读取所有源文件,将它们分成注释+代码两个部分,用适当的语言突出显示每个文件并在HTML模板中将它们打印出来,来为我们配置的源文件生成文档。document=(options={},callback)->config=configureoptionsfs.mkdirsconfig.output,->callbackor=(error)->throwerroriferrorcopyAsset=(file,callback)->returncallback()unlessfs.existsSyncfilefs.copyfile,path.join(config.output,path.basename(file)),callbackcomplete=->copyAssetconfig.css,(error)->returncallbackerroriferrorreturncopyAssetconfig.public,callbackiffs.existsSyncconfig.publiccallback()files=config.sources.slice()nextFile=->source=files.shift()fs.readFilesource,(error,buffer)->returncallbackerroriferrorcode=buffer.toString()sections=parsesource,code,configformatsource,sections,configwritesource,sections,configiffiles.lengththennextFile()elsecomplete()nextFile()更多详情请查看软件文档点击空白处退出提示
评论