深入lua-使用ldoc替代luadoc给lua生成文档.pdf

Lua-LDocLuaDocLua LDocLuaLuaLuaDoc2008 LDocLDocLuaLDocGithub LDocLuaDocLuaDocLuaDocLDoc LDocLuaDoc LDocMarkdown. LDoc LDocluaconfig.ldconfig.ld `ldoc . LDocPenlight,PenLightLuaFileSystem,LuaForWindows luarocksLDoc luarocks install LDoc config.ldtestLDocconfig.ld project=testLDoc title=⼀个⽤于测试LDoc的项⺫ description=⼀个⽤于测试LDoc的项⺫ file=. file所有⼦⺫录 lua Lua 这是⼀个测试⽤的Lua模块 -- 在此处，我们添加模块描述 -- @module Person -- @author wangxuanyi -- @license MIT -- @copyright NJU software Institue LDocJavaDocdoc comment doc comment - summary. -- Description; this can extend over -- several lines -- This will also do. Lua --[[-- Summary. A description ...; ]] Luamoduleexported functionslocal fucntionstablesfields table table -- 这是⼀个⼈的类，它有姓名和年龄两个属性 -- 在这个类中，我们规定了name和age的类型 -- @string name -- @int age -- @tparam person father person = { name = , age = 0, father = nil } exported function exported function 通过这个⽅法可以得到该Person的⽗亲 -- @treturn person father function person:getFather( ) return self.father end 解决⼀个平⽅根问题 -- @number a first coeff -- @number b second coeff -- @number c third coeff -- @return first root, or nil -- @return second root, or imaginary root error -- @usage local r1, r2 = solve(1, 2, 3) function solve (a,b,c) local disc = b^2 - 4*a*c if disc 0 then return nil,imaginary roots else disc = math.sqrt(disc) return (-b + disc)/2*a, (-b - disc)/2*a end end usage local functionfields local function fields fieldstable tparamtreturn tparam typename comment Persontparam Person need a Person Persontypename need a Personcomment LDoc LDocLDoc string number int bool func ‘function’ tab ‘table’ thread ’coroutine‘