mokdoc - 项目文档生成工具
-
基于MVC模式的文档生成工具
注释提取(Control)、文档数据(Model)、文档展示(View)完全分离。
强大的文档搜索能力
只要你记得注释中的一个词,就能搜出对应的文档。例如:
清晰的文档展示
如果你不满意默认提供的文档展示,完全可以轻松改造成你期望的样子。
传统文档工具不具备的新功能:数据字典收集
当数据部门追着你要某一系列零散分布于各个代码角落里的统计参数?当你想整理代码里某一类参数值?等等。你不用再去翻代码了,用注释搞定一切数据字典收集!
传统文档工具不具备的新功能:构建知识库
新人对你的项目足够了解吗?某个功能是不是被团队成员一问再问?他们记得住吗?你总是能耐心讲解吗?不用再等了,赶快拿起你的电话拨打……错了,赶快开始在你的代码里构建知识库吧。
强大的自定义标签能力、二次开发能力
我相信你一定会有你自己的想法,你一定会想加一下适合你项目场景的功能,mokdoc提供了灵活易扩展的架构,每一个注释标签都完全模块化,自定义你自己的标签轻而易举。
更简洁的注释语法
简化传统注释语法,注释看起来更简洁,同时也降低了写注释的成本,写注释更快了。
计划增加的特性
-
目前计划后续会增加以下功能,如有必要,会将更多功能列入开发计划:
功能特性 状态 列入计划时间 兼容传统的块注释语法 未开始 2014-07-29 运行测试用例 未开始 2014-07-29