帮助文档的数据库结构
?
自然框架一直沒有完整的幫助文檔,只是有幾個簡單的示例。這個就是差距呀,那么幫助文檔要怎么寫呢?有工具可以自動生成,但是總感覺自動生成的一點都不好用,自己都看不懂。既然要弄文檔,那么弄出來的文檔就應該能夠讓大家看著方便,能夠看明白是怎么回事。
?
MSDN是一種標準的幫助文檔格式吧,只是我不大會看,或者說看著很頭痛。學習jQuery,看了jQuery的chm的文檔,結構還可以基本可以看懂。于是就想按照jQuery的chm文檔的結構來做一個。但是已考慮細節就發現不行。jQuery的文檔只有一種,那就是方法。沒有屬性、事件、委托等。但是自然框架里有這些呀,不弄出來就不夠完善。
?
于是有回過頭來看看msdn。這里參照了吳旗娃的分頁控件的幫助文檔的格式,加了一些自認為可以增加閱讀性的東東。弄出來了下面的數據表結構。
?
??????
?
【2月7日 修改】?
欄目名稱:就是幫助文檔了。
欄目分類:共用函數、數據訪問、分頁控件、基礎控件、元數據控件、頁面基類等。
幫助的分類:一般用法,類、委托、枚舉,屬性、事件、方法,等。
詳細介紹:就是詳細說明了,這里側重jQuery的chm的形式。
參數詳細:一個方法可能會有多個參數,所以單獨做了個表,一對多。
示例詳細:一個方法也可以有多個示例。
?
基本就是這樣,欄目是大分類,欄目分類是中分類,都是一級的。幫助的分類是小分類n級的。詳細介紹就是樹葉了。
?
看到dudu在過年的時候都沒有休息,真的是佩服呀。
?
總結
以上是生活随笔為你收集整理的帮助文档的数据库结构的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 恶心的C语言strtok函数
- 下一篇: Windows Phone 7 程序菜单