最近做项目生成代码文档,兴高采烈的使用doxygen生成代码文档结果被批的一B,说实在太丑,换了个代码生成工具smartdoc,效果图:
嗯比doxygen养眼多了,smartdoc是一款为js代码生成的工具(我修改了里面的源码,可以支持c/c++/java/任何语言)。
不懂请谷歌/必应一下(别用垃圾百度)。
npm install -g smartdoc
配置一个文件docConfig.js(文件名必须用这个名字)。
module.exports = { //扫描的文件路径 paths: ['include/'], //文档页面输出路径 outdir: 'd:/doc/cyclonedoc/youproject/', //outdir: 'smartdoc/', //项目信息配置 project: { //项目名称 name: 'Test NDK', description: '<br>'+ '<h2>Test NDK</h2> ' + '<br>'+ '<p class="platform">About</p> '+ '<p><ul>' + '<h5>- Good Good Stardy dayday up .'+ '<h5>- Good Good Stardy dayday up .'+ '<h5>- Good Good Stardy dayday up .</ul></p>'+ '<br>'+ '<p class="platform">Modules</p> '+ '<p><ul>' + '<li><h4>Aplication</h4></li>'+ '<li><h4>Cloudservice</li>'+ '<li><h4>Input</li>'+ '<li><h4>Media&Camera</li>'+ '<li><h4>Network</li>'+ '<li><h4>Security</li>'+ '<li><h4>Storage</li>'+ '<li><h4>System</li></ul></p>'+ '<br>'+ '<p class="platform">Version</p> '+ '<p><ul>' + '<li><h4>1.0.0</h5></li></ul></p>'+ '<p><ul><h5>- Cyclone NDK be born.</h5></ul></p>', //版本信息 version: '1.0.0', //地址信息 //url: 'http://www.just.test', //logo地址 logo : 'https://os.alipayobjects.com/rmsportal/ASFKAYuqAYzVaSZ.svg', //导航信息 navs: [{ name: "首页", url: "http://tv.alibaba.net/_site/index.html" },{ name: "文档", url: "http://www.baidu.com" },{ name: "下载", url: "http://www.baidu.com" },{ name: "SDK", url: "http://www.baidu.com" }] } };
http://yui.github.io/yuidoc/syntax/index.html
然后使用cmd,cd到docConfig.js所在目录,运行:
smartdoc
就可以生成文档了
修改文件C:\Users\用户名\AppData\Roaming\npm\node_modules\smartdocbak\node_modules\yuidocjs\lib\yuidoc.js(这是我的路径)的
OPTIONS选项,有个extension。
/** * The default list of configuration options * @property OPTIONS * @type Object * @final * @for YUIDoc */ var OPTIONS = { quiet: false, writeJSON: true, outdir: path.join(process.cwd(), 'out'), extension: '.h', exclude: '.DS_Store,.svn,CVS,.git,build_rollup_tmp,build_tmp,node_modules', norecurse: false, version: '0.1.0', paths: [], themedir: path.join(__dirname, 'themes', 'default'), syntaxtype: 'js' };