slowfei / gosfdoc

code document generator

gosfdoc - document generator

什么是gosfdoc

　　gosfdoc是一个项目帮助文档和代码文档的生成器，它可以在编写代码的同时与项目文档的编写兼顾其中。在团队进行协同操作或是API项目中可以很好的利用文档信息进行有效的交流。gosfdoc利用markdown格式规范编写文档内容，甚至可以将文档直接写在代码文件中。

　　gosfdoc是使用golang语言进行开发，并支持多种语言的文档解析（目前只支持go）。

开发gosfdoc的目的

　　在开发项目的时候往往代码和项目文档都是被留到最后才进行编写，其实等待最后才去完善文档是一项繁重而不情愿的工作。甚至项目开发周期在半年或者更长时间完成后对于文档就更没有心思去打理。如果在开发项目的同时去完善文档，也可以在编码时，利用文档来规划代码的实现，等待项目完成的时候文档也基本成型。这时就考虑到，文档该如何有效的进行编写？如果有效的部署让其他人更容易的浏览？gosfdoc就是为这些孕育而生的，它能够在编码的同时进行文档的编写，利用编写文档的思路规划代码的实现，内置web部署可以让其他人更好的查看，使用markdown格式规范文档的编写。

在线文档

UPDATE LOG Current version master v0.1.000

使用协议 MIT LICENSE

This library is licensed under MIT license. See LICENSE for details.