?

　　自然框架一直沒(méi)有完整的幫助文檔，只是有幾個(gè)簡(jiǎn)單的示例。這個(gè)就是差距呀，那么幫助文檔要怎么寫呢？有工具可以自動(dòng)生成，但是總感覺(jué)自動(dòng)生成的一點(diǎn)都不好用，自己都看不懂。既然要弄文檔，那么弄出來(lái)的文檔就應(yīng)該能夠讓大家看著方便，能夠看明白是怎么回事。

?

　　MSDN是一種標(biāo)準(zhǔn)的幫助文檔格式吧，只是我不大會(huì)看，或者說(shuō)看著很頭痛。學(xué)習(xí)jQuery，看了jQuery的chm的文檔，結(jié)構(gòu)還可以基本可以看懂。于是就想按照jQuery的chm文檔的結(jié)構(gòu)來(lái)做一個(gè)。但是已考慮細(xì)節(jié)就發(fā)現(xiàn)不行。jQuery的文檔只有一種，那就是方法。沒(méi)有屬性、事件、委托等。但是自然框架里有這些呀，不弄出來(lái)就不夠完善。

?

　　于是有回過(guò)頭來(lái)看看msdn。這里參照了吳旗娃的分頁(yè)控件的幫助文檔的格式，加了一些自認(rèn)為可以增加閱讀性的東東。弄出來(lái)了下面的數(shù)據(jù)表結(jié)構(gòu)。

?

??????

?

【2月7日 修改】?

　　欄目名稱：就是幫助文檔了。

　　欄目分類：共用函數(shù)、數(shù)據(jù)訪問(wèn)、分頁(yè)控件、基礎(chǔ)控件、元數(shù)據(jù)控件、頁(yè)面基類等。

　　幫助的分類：一般用法，類、委托、枚舉，屬性、事件、方法，等。

　　詳細(xì)介紹：就是詳細(xì)說(shuō)明了，這里側(cè)重jQuery的chm的形式。

　　參數(shù)詳細(xì)：一個(gè)方法可能會(huì)有多個(gè)參數(shù)，所以單獨(dú)做了個(gè)表，一對(duì)多。

　　示例詳細(xì)：一個(gè)方法也可以有多個(gè)示例。

?

　　基本就是這樣，欄目是大分類，欄目分類是中分類，都是一級(jí)的。幫助的分類是小分類n級(jí)的。詳細(xì)介紹就是樹(shù)葉了。

?

　　看到dudu在過(guò)年的時(shí)候都沒(méi)有休息，真的是佩服呀。

?

總結(jié)

以上是生活随笔為你收集整理的帮助文档的数据库结构的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。