• <ins id="pjuwb"></ins>
    <blockquote id="pjuwb"><pre id="pjuwb"></pre></blockquote>
    <noscript id="pjuwb"></noscript>
          <sup id="pjuwb"><pre id="pjuwb"></pre></sup>
            <dd id="pjuwb"></dd>
            <abbr id="pjuwb"></abbr>

            牽著老婆滿街逛

            嚴以律己,寬以待人. 三思而后行.
            GMail/GTalk: yanglinbo#google.com;
            MSN/Email: tx7do#yahoo.com.cn;
            QQ: 3 0 3 3 9 6 9 2 0 .

            Windows下使用luaDoc給lua生成文檔

            作者: 楊粼波
            Email: tx7do@yahoo.com.cn


                首先需要安裝lua,Windows下自然是安裝Lua For Windows咯,下載地址:http://code.google.com/p/luaforwindows/
            安裝以后它已經(jīng)包含了luadoc,所以無需我們再去下載,如果非要去下載的話,那么下載地址是:http://luadoc.luaforge.net/。

            然后,我們需要準備一個批處理文件,叫啥名字無所謂,我是取名叫做buildDoc.bat的,我用doxygen的時候也是叫這個名字的,以下是批處理文件的內(nèi)容:
            @echo on
            lua.exe 
            "%LUA_DEV%\lua\luadoc_start.lua" -"Docs" *
            pause
            它做了什么呢?它調(diào)用了lua.exe執(zhí)行了luadoc_start.lua這個腳本,傳入的參數(shù)-d "Docs"的意思是生成的文檔文件夾(輸出路徑),如果沒有則是生成在批處理文件當(dāng)前路徑。第二個參數(shù)是需要生成文檔的lua腳本文件列表(輸入文件),不過我們可以傳入了一個*,它會自動解析生成的,讓它遍歷當(dāng)前路徑的lua文件以及當(dāng)前路徑下面所有的子文件夾的lua文件。

            有了這個批處理文件,這個時候我們就可以生成lua的文檔了,只需要鼠標輕輕一點就可以了。^_^

            以下給出一點lua腳本的示例:
            --- 測試用表
            -- @class table
            -- @name p_GlobalOptions
            -- @field opt1 字段1
            -- @field opt2 字段2
            local p_GlobalOptions 
            = {
                        opt1 
            = nil, 
                        opt2 
            = nil,
            }
            這是一個表的簡單示例,其中
            -- @class table 
                     是表明其類型是一個表,
            -- @name 
                     p_GlobalOptions是表名,
            -- @field opt1 字段1
                     說明第一個字段是什么。
            -- @field opt2 字段2
                     說明第二個字段是什么。

            --------------------------------------------------------------------------------------
            -- @name test
            -- @description 嗯。。。這是一個測試方法的方法
            -- @param param1 參數(shù)1
            -- @param param2 參數(shù)2
            -- @return 沒有返回值哦
            -- @usage test()
            -- @see p_GlobalOptions 
            --------------------------------------------------------------------------------------
            function test(param1, param2)
            end
            -- @param param1 參數(shù)1
                     說明參數(shù)1;
            -- @return 沒有返回值哦
                     說明了返回值
            -- @usage test()
                     這里是給出一個示例代碼來;
            -- @see p_GlobalOptions
                     可以生成一個超鏈接,表明這個方法和p_GlobalOptions是有關(guān),你可以去查看。
            其實還可以改改這么寫:
            --------------------------------------------------------------------------------------
            -- @class function
            -- @name test
            --------------------------------------------------------------------------------------
            -- @description 嗯。。。這是一個測試方法的方法
            -- @param param1 參數(shù)1
            -- @param param2 參數(shù)2
            -- @return 沒有返回值哦
            -- @usage test()
            -- @see p_GlobalOptions 
            --------------------------------------------------------------------------------------
            即,表明其類型是一個function,名字叫做test。
            @class有三個參數(shù):function, table 和 module。分別表示是:方法,表和模塊。

            具體文檔請參見: http://luadoc.luaforge.net/manual.html


            -------------------------------------------------------------------------------------------------------------
            來點閑話,最近工作已經(jīng)放到了使用lua做開發(fā)上面去了,沒辦法,廣州這邊的游戲公司基本上都是用腳本做大部分事情。
            至于為什么要這樣倚重腳本,無非就是:出于人員培訓(xùn)的考慮,出于快速開發(fā)的考慮……
            沒有復(fù)雜的數(shù)據(jù)類型,甚至于其實根本不用管數(shù)據(jù)類型是什么,因為它是一個弱類型的語言……
            只有一個數(shù)據(jù)結(jié)構(gòu):table,可以做變長數(shù)組,可做hash表,甚至用于模擬Class……
            你可以不用聲明類型,它可以叫做“使用即聲明”。你一不小心把名字寫錯了,解釋器還不報錯:這是合法的。想要捕獲這種錯誤,還需要一些技巧性的解決方法。
            沒有像VS那樣好用的IDE(因為我自始自終都在用著這個讓人惰性化的工具),雖然有UEStudio、EditPlus、NotePad++、SciTe、GVIM、LuaEdit,甚至于Eclipse也可以用,但是,始終不覺得好用。
            調(diào)試起來也不大方便,不過還好有Decoda這個支持遠程調(diào)試器的好東西,至少還有的用。
            不管怎樣,
            弱類型有弱類型的好處,實現(xiàn)委托不是那么困難的事情了,也不需要使用像boost:any這樣的玩意了。C++中所需要思考的東西一下子不再需要去煩擾了。
            不過我卻依然快不起來,語言上所要困擾的東西雖然少了許多,但是習(xí)慣它總是需要時間的。
            而且,融入新團隊,溝通,這些開發(fā)中的成本始終是存在的,不管用什么編程語言,不管做什么項目,不管在什么公司……

            posted on 2010-07-25 04:48 楊粼波 閱讀(3957) 評論(2)  編輯 收藏 引用 所屬分類: 原創(chuàng)文章

            評論

            # re: Windows下使用luaDoc給lua生成文檔 2010-07-25 11:45 戰(zhàn)魂小筑

            很好的文章,luadoc確實很好用  回復(fù)  更多評論   

            # re: Windows下使用luaDoc給lua生成文檔 2010-07-25 19:12 楊粼波

            還好,比起doxygen,還是很難用的。
            支持的標簽還很少,
            比如@file @virsion 等等……
            需要自己擴展一下才行。

            不過,有比沒有好呀。。。。  回復(fù)  更多評論   

            久久久久青草线蕉综合超碰| 久久精品国产亚洲AV无码麻豆| 久久久精品无码专区不卡| 亚洲Av无码国产情品久久| 人妻丰满AV无码久久不卡| 成人国内精品久久久久影院VR| 色偷偷91久久综合噜噜噜噜| 久久综合噜噜激激的五月天| 国产精品99久久不卡| 久久天天躁狠狠躁夜夜网站| 久久91这里精品国产2020| 人人狠狠综合久久88成人| 久久中文字幕视频、最近更新| 热re99久久6国产精品免费| 久久青青草原精品国产软件 | 久久精品人人槡人妻人人玩AV| 一本大道久久a久久精品综合| 久久精品无码一区二区WWW| 国内精品久久久久久久涩爱| 久久国产精品无码一区二区三区| 久久人妻少妇嫩草AV蜜桃| 国产精品视频久久| 国产精品久久久久国产A级| 久久婷婷五月综合成人D啪| 久久久久亚洲AV成人网人人网站 | 久久精品18| 国产精品视频久久| 精品久久久久久亚洲精品| 少妇久久久久久被弄高潮| 伊人久久大香线蕉无码麻豆| 国内精品久久久久久久影视麻豆 | 欧美伊人久久大香线蕉综合| 久久亚洲视频| 久久综合色区| 色8激情欧美成人久久综合电| 国产一区二区精品久久凹凸 | 亚洲精品国产自在久久| 久久精品国产亚洲一区二区三区 | 久久综合鬼色88久久精品综合自在自线噜噜 | 婷婷久久精品国产| 亚洲国产成人久久精品99|