摘要:腳本介紹目錄結(jié)構(gòu)其中生成的文檔將保存到目錄下文件實(shí)現(xiàn)從文件中獲取數(shù)據(jù)庫表結(jié)構(gòu)文件為上面文件中獲取到的數(shù)據(jù)庫表結(jié)構(gòu)加入語法文件為運(yùn)行文件,運(yùn)行該文件,即可實(shí)現(xiàn)文檔生成。為腳本使用說明。
0x00 起因
來新公司實(shí)習(xí)剛過一周時(shí)間,一開始都在嘗試看項(xiàng)目代碼,數(shù)據(jù)庫表結(jié)構(gòu)等,因?yàn)闆]有完備的文檔,所以看起來還是相當(dāng)困難的,也是因?yàn)榭磾?shù)據(jù)庫時(shí),每次需要一張表一張表的翻,非常麻煩,就想著寫個(gè)腳本通過SQL文件生成數(shù)據(jù)庫文檔,而且當(dāng)前比較流行markdown,所以就為SQL文件生成了md格式的數(shù)據(jù)庫文檔,于是就有了該腳本。
0x01 腳本介紹目錄結(jié)構(gòu):
md/ FileParserClass.py MarkdownBuildClass.py build.py README.md
其中生成的md文檔將保存到md目錄下.
FileParserClass.py文件實(shí)現(xiàn)從SQL文件中獲取數(shù)據(jù)庫表結(jié)構(gòu)
MarkdownBuildClass.py文件為上面文件中獲取到的數(shù)據(jù)庫表結(jié)構(gòu)加入md語法
build.py文件為運(yùn)行文件,運(yùn)行該文件,即可實(shí)現(xiàn)文檔生成。
README.md為腳本使用說明。
SQL文件圖:
生成的md文件圖:
解析后的文件圖:
0x03 GitHub 目錄0x04 BUG反饋傳送門:https://github.com/2liang/AutoBuildDocFromDB
因?yàn)槲业臏y試SQL文件比較簡單,而且測試的SQL文件比較少,難免其中出現(xiàn)問題,如有遇到BUG,還希望能夠發(fā)我郵箱。郵箱:[email protected]
原文作者:我才是二亮
原文鏈接:http://www.2liang.me/archives/264
轉(zhuǎn)載必須在正文中標(biāo)注并保留原文鏈接、作者等信息。
[4]: https://github.com/2liang/AutoBuildDocFromDB
文章版權(quán)歸作者所有,未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請注明本文地址:http://systransis.cn/yun/37802.html
摘要:一的官方資料官方文檔源碼二介紹大致的意思是可以幫助所有版本的和以上版本的生成代碼。其中目前最新的版本可以使用。指定生成一系列對象的環(huán)境。定義了生成的注釋形式。與生成的實(shí)體相關(guān)。生成接口和類以達(dá)到輕易使用生成的模型和映射文件的目的。 一:MyBatis Generator的官方資料 MyBatis Generator官方文檔github源碼:MyBatis Generator (MBG)...
摘要:如何構(gòu)建一個(gè)自己的框架為什么我們要去構(gòu)建一個(gè)自己的框架可能絕大多數(shù)的人都會說市面上已經(jīng)那么多的框架了,還造什么輪子。 showImg(https://segmentfault.com/img/bVNg9F?w=500&h=500); 如何構(gòu)建一個(gè)自己的PHP框架 為什么我們要去構(gòu)建一個(gè)自己的PHP框架?可能絕大多數(shù)的人都會說市面上已經(jīng)那么多的框架了,還造什么輪子?。我的觀點(diǎn)造輪子不是目...
摘要:整合階段由于沒有對的快速啟動裝配,所以需要我自己導(dǎo)入相關(guān)的,包括數(shù)據(jù)源,包掃描,事物管理器等。另外它的中文文檔比較友好。源碼下載參考資料中文文檔 BeetSql是一個(gè)全功能DAO工具, 同時(shí)具有Hibernate 優(yōu)點(diǎn) & Mybatis優(yōu)點(diǎn)功能,適用于承認(rèn)以SQL為中心,同時(shí)又需求工具能自動能生成大量常用的SQL的應(yīng)用。 beatlsql 優(yōu)點(diǎn) 開發(fā)效率 無需注解,自動使用大...
閱讀 981·2021-11-25 09:43
閱讀 2303·2019-08-30 15:55
閱讀 3165·2019-08-30 15:44
閱讀 2065·2019-08-29 16:20
閱讀 1465·2019-08-29 12:12
閱讀 1620·2019-08-26 12:19
閱讀 2294·2019-08-26 11:49
閱讀 1724·2019-08-26 11:42