試用了下lua專屬的注釋生成文檔工具luaDoc，基本模式和doxygen差不多，不過感覺更簡單一些
1. 前期準備工作，及編譯方法
luaDoc需要依賴luaFileSystem和luaLogging，因此我使用的是一個整合包http://luaforwindows.luaforge.net/
要開始使用時，在5.1\lua下找到luadoc_start.lua文件，這個文件就是luadoc的啟動文件
找到你需要制作的lua文件的目錄制作一個類似這樣的bat
lua "d:\Program Files\Lua\5.1\lua\luadoc_start.lua" xxx.lua
這里注意：lua是已經注冊到系統路徑的，如果你沒有安裝整合包，需要手動加一下
如果需要批量生成，只需要用*.lua既可以
生成出來的網頁文件放置在你的源碼目錄，用index.html開始查看
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
} )
endluaDoc從---開始識別你的函數注釋，這個被放置于函數主要說明中
@param用作參數說明，selfclass標記是哪個參數的說明
@return說明返回值
@usage就是一些例子