luaDoc試用心得

luaDoc試用心得
luaの専属注釈を使って文書作成ツールluaDocを作ってみました.基本モードはdoxygenと同じです.でも、もっと簡単な感じがします.
1.前期準備作業及びコンパイル方法
luaDocはlua FileSystemとluaLoggに依存する必要がありますので、私が使っているのは統合パッケージです.http://luaforwindows.luaforge.net/
使い始めるには、5.1\luaの下でluadoc_を見つけます.start.luaファイルは、このファイルがluadocの起動ファイルです.
あなたが作成したいluaファイルのカタログを見つけて、このようなbatを作ります.
lua「d:\Program Files\Lua\5.1\luadoc.lua」xxx.lua
ここで注意してください.luaはシステムパスに登録されています.もし統合パッケージがインストールされていないなら、手動で追加してください.
一括生成が必要なら、＊.luaだけでも大丈夫です.
作成したウェブページのファイルをソースディレクトリに置いて、index.で確認します.
 
2.luaDocにプログラムのコメントを認識させる
基本的な注釈構造を見てください.

---     table      
-- @param selfclass  table
-- @param parentclass      table
-- @return      
-- @usage local _widgetnotebox =  _Inherit( {}, WIDGET_BASE )
function _Inherit( selfclass, parentclass )
    if not parentclass then
        error("parentclass null", 2 )
    end
    return setmetatable( selfclass, 
    {
    __index = function( t, k )
        local ret = parentclass[k]
        selfclass[k]= ret
        return ret
    end
    
    } )
end

luaDoc ---          ，             

@param      ，selfclass          

@return     

@usage