LUA语言编程规范.doc

Lua编程规范

文档日期:2011-09-23
目录
TOC\o"1-3"\h\z\uHYPERLINK\l"_Toc304558906"1. 版本和版权问题 PAGEREF_Toc304558906\h3
HYPERLINK\l"_Toc304558907"2. 排版 PAGEREF_Toc304558907\h3
HYPERLINK\l"_Toc304558908"2.1空格 PAGEREF_Toc304558908\h3
HYPERLINK\l"_Toc304558909"2.2空行 PAGEREF_Toc304558909\h3
HYPERLINK\l"_Toc304558910"2.3代码行 PAGEREF_Toc304558910\h3
HYPERLINK\l"_Toc304558911"2.4比较规范 PAGEREF_Toc304558911\h3
HYPERLINK\l"_Toc304558912"3. 注释 PAGEREF_Toc304558912\h4
HYPERLINK\l"_Toc304558913"3.1注释符号 PAGEREF_Toc304558913\h4
HYPERLINK\l"_Toc304558914"3.2注释量 PAGEREF_Toc304558914\h4
HYPERLINK\l"_Toc304558915"3.3注释区域 PAGEREF_Toc304558915\h4
HYPERLINK\l"_Toc304558916"3.4全局变量注释 PAGEREF_Toc304558916\h4
HYPERLINK\l"_Toc304558917"4. 命名规范 PAGEREF_Toc304558917\h5
HYPERLINK\l"_Toc304558918"5. 其他规范 PAGEREF_Toc304558918\h5


版本和版权问题
版权和版本的声明位于定义文件的开头（参见示例1-1），主要内容有：
（1）版本号<主版本号><次版本号><修订号>
（2）文件名称
（3）功能描述
（4）创建人
（5）创建时间

图1-1版本信息示例
排版
2.1空格
程序块间要采用缩进风格编写，缩进空格数为Tab。连接运算符“..”两边要有空格。如：a..b
2.2空行
相对独立的程序块之间，如函数块之后必须加空行。（注：空行不占内存）如下：两个函数之间必须要加空行。
functiondistance(destX,destY,destZ,srcX,srcY,srcZ)
returnmath.sqrt((destX-srcX)^2+(destY-srcY)^2+(destZ-srcZ)^2)
end

functioncheckDistance(destX,destY,destZ,srcX,srcY,srcZ)
iw.log(“ssss”)
end

2.3代码行
较长的语句要分成多行书写，每行代码不超过70字符，一行代码最好只做一件事情，比如只写一个语句，或只定义一个变量，这样的代码容易阅读，方便注释。
if…then…return…end要分行写，if、for等语句自占一行，执行语句不得紧跟其后。
2.4比较规范
关系运算符两边最好用空格。
（1）nil：a==nil
（2）int/string:a==163/a==“Wingszero”
（3）Boolean:ifa/ifnota
（4）杜绝比较不同类型的对象
注释
3.1注释符号
单行注释：--
多行注释：--[[--]]
3.2注释量
一般情况下，源程序有效注释量必须在20%以上。
3.3注释区域
注释通常用于以下：
（1）版本、版权声明；
（2）函数接口说明；
（3）重要的代码行或段落提示。
注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方。注释与其下面的代码用空行分隔开来。如图3-1

图3-1
注意：注释的原则是有助于对程序的阅读理解，注释也不宜太多。注释可以是中文或英文，但最好用英文，防止产生乱码问题。
3.4全局变量注释
全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数存取它以及存取它时的注意事项等的说明。
命名规范
变量：驼峰法，eg：playerName变量的命名要见名知意，便于阅读和修改。
（2）常量：大写加下划线eg：KIND_PET_FOOD
（3）函数：和变量一致，eg：functioncheckTaskChainStatus()
（4）模块：小写加下划线：eg：item_factory_lua