• <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/
            安裝以后它已經包含了luadoc,所以無需我們再去下載,如果非要去下載的話,那么下載地址是:http://luadoc.luaforge.net/

            然后,我們需要準備一個批處理文件,叫啥名字無所謂,我是取名叫做buildDoc.bat的,我用doxygen的時候也是叫這個名字的,以下是批處理文件的內容:
            @echo on
            lua.exe 
            "%LUA_DEV%\lua\luadoc_start.lua" -"Docs" *
            pause
            它做了什么呢?它調用了lua.exe執行了luadoc_start.lua這個腳本,傳入的參數-d "Docs"的意思是生成的文檔文件夾(輸出路徑),如果沒有則是生成在批處理文件當前路徑。第二個參數是需要生成文檔的lua腳本文件列表(輸入文件),不過我們可以傳入了一個*,它會自動解析生成的,讓它遍歷當前路徑的lua文件以及當前路徑下面所有的子文件夾的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 參數1
            -- @param param2 參數2
            -- @return 沒有返回值哦
            -- @usage test()
            -- @see p_GlobalOptions 
            --------------------------------------------------------------------------------------
            function test(param1, param2)
            end
            -- @param param1 參數1
                     說明參數1;
            -- @return 沒有返回值哦
                     說明了返回值
            -- @usage test()
                     這里是給出一個示例代碼來;
            -- @see p_GlobalOptions
                     可以生成一個超鏈接,表明這個方法和p_GlobalOptions是有關,你可以去查看。
            其實還可以改改這么寫:
            --------------------------------------------------------------------------------------
            -- @class function
            -- @name test
            --------------------------------------------------------------------------------------
            -- @description 嗯。。。這是一個測試方法的方法
            -- @param param1 參數1
            -- @param param2 參數2
            -- @return 沒有返回值哦
            -- @usage test()
            -- @see p_GlobalOptions 
            --------------------------------------------------------------------------------------
            即,表明其類型是一個function,名字叫做test。
            @class有三個參數:function, table 和 module。分別表示是:方法,表和模塊。

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


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

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

            評論

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

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

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

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

            不過,有比沒有好呀。。。。  回復  更多評論   

            久久精品国产精品亚洲毛片| 精产国品久久一二三产区区别| 午夜天堂av天堂久久久| 久久精品国产亚洲av影院| 91久久精品电影| 久久免费视频1| 久久亚洲国产精品一区二区| 色综合久久久久综合99| 97久久天天综合色天天综合色hd| 亚洲一区中文字幕久久| 欧美精品九九99久久在观看| 996久久国产精品线观看| 久久av免费天堂小草播放| 伊人久久综合精品无码AV专区| 久久精品免费观看| 久久无码AV一区二区三区| 色综合久久中文综合网| 久久久久亚洲AV无码永不| 国产亚洲美女精品久久久| 久久精品水蜜桃av综合天堂| 久久久久久午夜精品| 国产精品内射久久久久欢欢| 久久久久亚洲av无码专区| 久久亚洲中文字幕精品一区四| 2021精品国产综合久久| 久久久无码人妻精品无码| 一级a性色生活片久久无| 狠狠色婷婷综合天天久久丁香 | 久久国产精品-国产精品| 久久中文字幕人妻熟av女| 久久人人爽人人澡人人高潮AV| 国产精品美女久久久久网| 久久亚洲AV成人无码国产| 亚洲精品乱码久久久久久蜜桃不卡| 亚洲精品NV久久久久久久久久| 国内精品伊人久久久久网站| 国产成人香蕉久久久久| 国产精品永久久久久久久久久 | 人妻无码精品久久亚瑟影视| 热久久国产欧美一区二区精品 | 亚洲日韩欧美一区久久久久我|