guoyu07 / phpmysqldoc

将mysql数据库实例里的注释生成为markdown格式的文本

Example

a table in database named tablefortest

--  DROP TABLE IF EXISTS `tablefortest`;
CREATE TABLE `tablefortest` (
  `test1` varchar(8) COMMENT 'comment1',
  `test2` char(8) COMMENT 'comment12',
  `test3` varchar(8) COMMENT 'comment13',
  `test4` varchar(8) COMMENT 'comment14'
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='just for test~';

php code

require 'phpmysqldoc.php';

$host = '';
$port = '';
$user = '';
$password = '';
$database = 'test';
// or $database = array('test','test2');

$mysqli = pmd_getMysqli($host, $port, $user,  $password);
$text = pmd_generateDoc($mysqli, $database);
writeToFile($text,'test.md');

file://test.md

It looks like this:

---

@instruction 你需要能够直视Markdown的浏览器，推荐用Chrome的扩展Markdown Reader（带目录功能）
@author php script wrote by Cupen<[email protected]>
@date 2013-03-23 10:32:33

---

test

tablefortest -- just for test~

test1	varchar	comment1
test2	char	comment12
test3	varchar	comment13
test4	varchar	comment14