試用了下lua專屬的注釋生成文檔工具luaDoc，基本模式和doxygen差不多，不過(guò)感覺(jué)更簡(jiǎn)單一些
1. 前期準(zhǔn)備工作，及編譯方法
luaDoc需要依賴luaFileSystem和luaLogging，因此我使用的是一個(gè)整合包http://luaforwindows.luaforge.net/
要開始使用時(shí)，在5.1\lua下找到luadoc_start.lua文件，這個(gè)文件就是luadoc的啟動(dòng)文件
找到你需要制作的lua文件的目錄制作一個(gè)類似這樣的bat
lua "d:\Program Files\Lua\5.1\lua\luadoc_start.lua" xxx.lua
這里注意：lua是已經(jīng)注冊(cè)到系統(tǒng)路徑的，如果你沒(méi)有安裝整合包，需要手動(dòng)加一下
如果需要批量生成，只需要用*.lua既可以
生成出來(lái)的網(wǎng)頁(yè)文件放置在你的源碼目錄，用index.html開始查看
2. 讓luaDoc識(shí)別程序里的注釋
看下基本注釋結(jié)構(gòu)：
--- 繼承于某table的屬性及函數(shù)
-- @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從---開始識(shí)別你的函數(shù)注釋，這個(gè)被放置于函數(shù)主要說(shuō)明中
@param用作參數(shù)說(shuō)明，selfclass標(biāo)記是哪個(gè)參數(shù)的說(shuō)明
@return說(shuō)明返回值
@usage就是一些例子