lua代码编写规范.pdf

代码编写规范 开发中，大量使用 lua，暂时根据当前状况，总结相对而言较好的规范，在多人协作中可以 更好的开发、交流。 介绍 该文档旨在为使用lua编写应用程序建立编码指南。 制订编码规范的目的： ? 统一编码标准，通用。提高开发效率； ? 使代码通俗易懂，易于维护。 切记：善用调试器。 目录 代码编写规范 ......................................................................................................................................... 1 目录.......................................................................................................................................................... 1 一、 命名惯例 ................................................................................................................................ 3 1．所有 lua 文件命名时使???小写字母 ...................................................................................... 3 2．类名、变量名等全小写，尽可能使用有意义的英文，单词若生僻，则用 _ 分割.... 3 3．文件内局部变量加 s_前缀 .................................................................................................... 3 4．常量、消息号定义时用大写，单词间 _ 分割 .................................................................. 3 5．枚举值定义时 加前缀 enum_ .............................................................................................. 3 二、 文件组织 ................................................................................................................................ 3 1. 文件开头加上此文件的功能、职责的简要描述； 每个文件都加 module 限定词； 导 入的模块都加 local 限定词； .................................................................................................... 3 2. 所有函数都加如下格式的注释。 ....................................................................................... 3 3. 函数与函数间、以及一些定义之间加上空行。 .............................................................. 3 4. 文件内不允许出现全局变量，_G.instance 例外 ............................................................. 3 5. 函数内的临时变量、文件内的局部函数都加上 local 限定词 .....